Delivery Method Management

Data Structures
struct	DeliveryMethodInstance_t
	Structure to represent an instance of a delivery method. More...
struct	DeliveryMethodHandler_t
	Structure used to describe a Delivery Method Handler. More...
Functions
int	DeliveryMethodManagerInit (void)
void	DeliveryMethodManagerDeInit (void)
void	DeliveryMethodManagerRegister (DeliveryMethodHandler_t *handler)
	Register a Delivery Method handler with the manager.
void	DeliveryMethodManagerUnRegister (DeliveryMethodHandler_t *handler)
	Unregiser a Delivery Method handler with the manager.
bool	DeliveryMethodManagerFind (char *mrl, PIDFilter_t *filter)
	Find a Delivery method handler for the specified mrl and set the outputpacket callback on the specified PID filter to use this handler.
void	DeliveryMethodManagerFree (PIDFilter_t *filter)
	Release a Delivery method handler previously set on the specified PID filter.
char *	DeliveryMethodGetMRL (PIDFilter_t *filter)
	Retrieve the mrl used to setup the output on the specified filter.
DeliveryMethodInstance_t *	DeliveryMethodCreate (char *mrl)
	Create a new DeliveryMethodInstance_t that can handle the supplied MRL.
void	DeliveryMethodDestroy (DeliveryMethodInstance_t *instance)
	Destory a DeliveryMethodInstance_t previously created by DeliveryMethodCreate().
void	DeliveryMethodDestroyAll ()
void	DeliveryMethodOutputPacket (PIDFilter_t *pidfilter, void *userarg, TSPacket_t *packet)
	Function to use with a PIDFilter as the PacketOutput function.

---

Function Documentation

DeliveryMethodInstance_t* DeliveryMethodCreate

(

char *

mrl

)

Create a new DeliveryMethodInstance_t that can handle the supplied MRL.

Parameters:

mrl

The MRL the delivery method should handle.

Returns:

A DeliveryMethodInstance_t if the supplied MRL can be handled or NULL.

void DeliveryMethodDestroy

(

DeliveryMethodInstance_t *

instance

)

Destory a DeliveryMethodInstance_t previously created by DeliveryMethodCreate().

Parameters:

instance

The instance to free.

void DeliveryMethodDestroyAll

(

)

For internal use only.

Destroy all DeliveryMethodInstance_t instances. NOTE: This function will be called before plugin manager shutsdown all plugins. This is to ensure all delivery method instances are correctly closed down. Plugins should not attempt to destroy delivery method instances, as the plugin providing the method may have already been shutdown.

char* DeliveryMethodGetMRL

(

PIDFilter_t *

filter

)

Retrieve the mrl used to setup the output on the specified filter.

Parameters:

filter

The PIDFilter to retrieve the MRL from.

Returns:

The MRL string.

void DeliveryMethodManagerDeInit

(

void

)

For internal use only.

De-Initialise the Delivery method manager.

bool DeliveryMethodManagerFind	(	char *	mrl,
		PIDFilter_t *	filter
	)

Find a Delivery method handler for the specified mrl and set the outputpacket callback on the specified PID filter to use this handler.

Parameters:

	mrl	The mrl to send the packets to.
	filter	The PID filter to set the handler on.

void DeliveryMethodManagerFree

(

PIDFilter_t *

filter

)

Release a Delivery method handler previously set on the specified PID filter.

Parameters:

filter

The PID filter to release the handler from.

int DeliveryMethodManagerInit

(

void

)

For internal use only.

Initialise the Delivery method manager.

Returns:

0 on success.

void DeliveryMethodManagerRegister

(

DeliveryMethodHandler_t *

handler

)

Register a Delivery Method handler with the manager.

Parameters:

handler

The handler to register.

void DeliveryMethodManagerUnRegister

(

DeliveryMethodHandler_t *

handler

)

Unregiser a Delivery Method handler with the manager.

Parameters:

handler

The handler to remove from the available handlers.

void DeliveryMethodOutputPacket	(	PIDFilter_t *	pidfilter,
		void *	userarg,
		TSPacket_t *	packet
	)

Function to use with a PIDFilter as the PacketOutput function.

The oparg variable of the PIDFilter structure should be set to a valid DeliveryMethodInstance_t.

Parameters:

	pidfilter	The pid filter that is output a packet.
	userarg	Must be a valid DeliveryMethodInstance_t.
	packet	The packet to output.