rtsp_server.h File Reference

RTSP Server. More...

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

Include dependency graph for rtsp_server.h:

Go to the source code of this file.

Data Structures
struct	rtsp_server_vtable_t

Typedefs
typedef typedefAPT_BEGIN_EXTERN_C struct rtsp_server_t	rtsp_server_t
typedef struct rtsp_server_session_t	rtsp_server_session_t
typedef struct rtsp_server_vtable_t	rtsp_server_vtable_t

Functions
rtsp_server_t *	rtsp_server_create (const char *id, const char *listen_ip, apr_port_t listen_port, apr_size_t max_connection_count, apr_size_t connection_timeout, void *obj, const rtsp_server_vtable_t *handler, apr_pool_t *pool)
apt_bool_t	rtsp_server_destroy (rtsp_server_t *server)
apt_bool_t	rtsp_server_start (rtsp_server_t *server)
apt_bool_t	rtsp_server_terminate (rtsp_server_t *server)
apt_task_t *	rtsp_server_task_get (const rtsp_server_t *server)
void *	rtsp_server_object_get (const rtsp_server_t *server)
apt_bool_t	rtsp_server_session_respond (rtsp_server_t *server, rtsp_server_session_t *session, rtsp_message_t *message)
apt_bool_t	rtsp_server_session_terminate (rtsp_server_t *server, rtsp_server_session_t *session)
apt_bool_t	rtsp_server_session_release (rtsp_server_t *server, rtsp_server_session_t *session)
void *	rtsp_server_session_object_get (const rtsp_server_session_t *session)
void	rtsp_server_session_object_set (rtsp_server_session_t *session, void *obj)
const apt_str_t *	rtsp_server_session_id_get (const rtsp_server_session_t *session)
const rtsp_message_t *	rtsp_server_session_request_get (const rtsp_server_session_t *session)
const char *	rtsp_server_session_destination_get (const rtsp_server_session_t *session)

Detailed Description

RTSP Server.

Typedef Documentation

rtsp_server_session_t

typedef struct rtsp_server_session_t rtsp_server_session_t

Opaque RTSP server session declaration

rtsp_server_t

typedef typedefAPT_BEGIN_EXTERN_C struct rtsp_server_t rtsp_server_t

Opaque RTSP server declaration

rtsp_server_vtable_t

typedef struct rtsp_server_vtable_t rtsp_server_vtable_t

RTSP server vtable declaration

Function Documentation

rtsp_server_create()

rtsp_server_t* rtsp_server_create	(	const char *	id,
		const char *	listen_ip,
		apr_port_t	listen_port,
		apr_size_t	max_connection_count,
		apr_size_t	connection_timeout,
		void *	obj,
		const rtsp_server_vtable_t *	handler,
		apr_pool_t *	pool
	)

Create RTSP server.

Parameters

id	the identifier of the server
listen_ip	the listen IP address
listen_port	the listen port
max_connection_count	the number of max RTSP connections
connection_timeout	the inactivity timeout for an RTSP connection [sec]
obj	the external object to send events to
handler	the request handler
pool	the pool to allocate memory from

rtsp_server_destroy()

apt_bool_t rtsp_server_destroy

(

rtsp_server_t *

server

)

Destroy RTSP server.

Parameters

server

the server to destroy

rtsp_server_object_get()

void* rtsp_server_object_get

(

const rtsp_server_t *

server

)

Get external object.

Parameters

server

the server to get object from

rtsp_server_session_destination_get()

const char* rtsp_server_session_destination_get

(

const rtsp_server_session_t *

session

)

Get the session destination (client) IP address.

Parameters

session

the session to get IP address from

rtsp_server_session_id_get()

const apt_str_t* rtsp_server_session_id_get

(

const rtsp_server_session_t *

session

)

Get the session identifier.

Parameters

session

the session to get identifier from

rtsp_server_session_object_get()

void* rtsp_server_session_object_get

(

const rtsp_server_session_t *

session

)

Get object associated with the session.

Parameters

session

the session to get object from

rtsp_server_session_object_set()

void rtsp_server_session_object_set	(	rtsp_server_session_t *	session,
		void *	obj
	)

Set object associated with the session.

Parameters

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

rtsp_server_session_release()

apt_bool_t rtsp_server_session_release	(	rtsp_server_t *	server,
		rtsp_server_session_t *	session
	)

Release RTSP session (internal release event/request).

Parameters

server	the server to use
session	the session to release

rtsp_server_session_request_get()

const rtsp_message_t* rtsp_server_session_request_get

(

const rtsp_server_session_t *

session

)

Get active (in-progress) session request.

Parameters

session

the session to get from

rtsp_server_session_respond()

apt_bool_t rtsp_server_session_respond	(	rtsp_server_t *	server,
		rtsp_server_session_t *	session,
		rtsp_message_t *	message
	)

Send RTSP message.

Parameters

server	the server to use
session	the session to send RTSP response for
message	the RTSP response to send

rtsp_server_session_terminate()

apt_bool_t rtsp_server_session_terminate	(	rtsp_server_t *	server,
		rtsp_server_session_t *	session
	)

Terminate RTSP session (respond to terminate request).

Parameters

server	the server to use
session	the session to terminate

rtsp_server_start()

apt_bool_t rtsp_server_start

(

rtsp_server_t *

server

)

Start server and wait for incoming requests.

Parameters

server

the server to start

rtsp_server_task_get()

apt_task_t* rtsp_server_task_get

(

const rtsp_server_t *

server

)

Get task.

Parameters

server

the server to get task from

rtsp_server_terminate()

apt_bool_t rtsp_server_terminate

(

rtsp_server_t *

server

)

Terminate server.

Parameters

server

the server to terminate