rtsp_client.h File Reference

RTSP Client. More...

#include "apt_task.h"
#include "rtsp_message.h"

Go to the source code of this file.

Data Structures
struct	rtsp_client_vtable_t
Typedefs
typedef typedefAPT_BEGIN_EXTERN_C struct rtsp_client_t	rtsp_client_t
typedef struct rtsp_client_session_t	rtsp_client_session_t
typedef struct rtsp_client_vtable_t	rtsp_client_vtable_t
Functions
rtsp_client_t *	rtsp_client_create (const char *id, apr_size_t max_connection_count, apr_size_t request_timeout, void *obj, const rtsp_client_vtable_t *handler, apr_pool_t *pool)
apt_bool_t	rtsp_client_destroy (rtsp_client_t *client)
apt_bool_t	rtsp_client_start (rtsp_client_t *client)
apt_bool_t	rtsp_client_terminate (rtsp_client_t *client)
apt_task_t *	rtsp_client_task_get (const rtsp_client_t *client)
void *	rtsp_client_object_get (const rtsp_client_t *client)
rtsp_client_session_t *	rtsp_client_session_create (rtsp_client_t *client, const char *server_ip, apr_port_t server_port, const char *resource_location)
void	rtsp_client_session_destroy (rtsp_client_session_t *session)
apt_bool_t	rtsp_client_session_terminate (rtsp_client_t *client, rtsp_client_session_t *session)
apt_bool_t	rtsp_client_session_request (rtsp_client_t *client, rtsp_client_session_t *session, rtsp_message_t *message)
void *	rtsp_client_session_object_get (const rtsp_client_session_t *session)
void	rtsp_client_session_object_set (rtsp_client_session_t *session, void *obj)
const apt_str_t *	rtsp_client_session_id_get (const rtsp_client_session_t *session)

---

Detailed Description

RTSP Client.

---

Typedef Documentation

typedef struct rtsp_client_session_t rtsp_client_session_t

Opaque RTSP client session declaration

typedef typedefAPT_BEGIN_EXTERN_C struct rtsp_client_t rtsp_client_t

Opaque RTSP client declaration

typedef struct rtsp_client_vtable_t rtsp_client_vtable_t

RTSP client vtable declaration

---

Function Documentation

rtsp_client_t* rtsp_client_create	(	const char *	id,
		apr_size_t	max_connection_count,
		apr_size_t	request_timeout,
		void *	obj,
		const rtsp_client_vtable_t *	handler,
		apr_pool_t *	pool
	)

Create RTSP client.

Parameters:

	id	the identifier of the client
	max_connection_count	the number of max RTSP connections
	request_timeout	the request timeout to set
	obj	the external object to send event to
	handler	the response/event handler
	pool	the pool to allocate memory from

apt_bool_t rtsp_client_destroy

(

rtsp_client_t *

client

)

Destroy RTSP client.

Parameters:

client

the client to destroy

void* rtsp_client_object_get

(

const rtsp_client_t *

client

)

Get external object.

Parameters:

client

the client to get object from

rtsp_client_session_t* rtsp_client_session_create	(	rtsp_client_t *	client,
		const char *	server_ip,
		apr_port_t	server_port,
		const char *	resource_location
	)

Create RTSP session.

Parameters:

	client	the client to create session for
	server_ip	the IP address of RTSP server
	server_port	the port of RTSP server
	resource_location	the location of RTSP resource (path in RTSP URI)

void rtsp_client_session_destroy

(

rtsp_client_session_t *

session

)

Destroy RTSP session.

Parameters:

session

the session to destroy

const apt_str_t* rtsp_client_session_id_get

(

const rtsp_client_session_t *

session

)

Get the session identifier.

Parameters:

session

the session to get identifier from

void* rtsp_client_session_object_get

(

const rtsp_client_session_t *

session

)

Get object associated with the session.

Parameters:

session

the session to get object from

void rtsp_client_session_object_set	(	rtsp_client_session_t *	session,
		void *	obj
	)

Set object associated with the session.

Parameters:

	session	the session to set object for
	obj	the object to set

apt_bool_t rtsp_client_session_request	(	rtsp_client_t *	client,
		rtsp_client_session_t *	session,
		rtsp_message_t *	message
	)

Send RTSP message.

Parameters:

	client	the client to use
	session	the session to send RTSP request for
	message	the RTSP request to send

apt_bool_t rtsp_client_session_terminate	(	rtsp_client_t *	client,
		rtsp_client_session_t *	session
	)

Terminate RTSP session.

Parameters:

	client	the client to use
	session	the session to terminate

apt_bool_t rtsp_client_start

(

rtsp_client_t *

client

)

Start client and wait for incoming requests.

Parameters:

client

the client to start

apt_task_t* rtsp_client_task_get

(

const rtsp_client_t *

client

)

Get task.

Parameters:

client

the client to get task from

apt_bool_t rtsp_client_terminate

(

rtsp_client_t *

client

)

Terminate client.

Parameters:

client

the client to terminate