CloseListenSession function
The CloseListenSession function will shutdown a ListenSession and remove the ListenSession from the settings.Syntax
int __stdcall CloseListenSession(
__in ProtocolSession *psess,
__in ListenSession *lsess
);
Parameters
psess [in] A pointer to a ProtocolSession structure. This is a session assigned to a protocol at the moment it's loaded into the memory.
lsess [in] A pointer to a ListenSession structure. This is a session assigned to a plugin at the moment a user defines a new connection.
Return value
If no error occurs the function returns True (one). If the function fails it will return False (zero).
Remarks
This function will make a call to the function
PrepareCloseListenSession from the Receiver protocol in
lsess. This function should make the
StartListening function return false. Next
CloseClientSession will be called for every
Clientsession(s) associated with
lsess. Last the
ListenSession will be closed by calling CloseListenSession function exported by all the protocols in the
ListenSession. This functions should remove every recource previously allocated by the
BindToProtocolCallBack function.
The
ListenSession will also be removed from the settings, this means next time TV's server starts, the
ListenSession will not be recovered. Use
CloseListenSessionEx to modify this behavior.
Requirements
| Should be exported by | Receiver, Transformer and Processor plugin.
|
| Minimum supported API | 1.00
|
| Header | tvsserver_base.h
|