CloseListenSession function
The CloseListenSession function will shutdown a listensession.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 of the Receiver protocol in this
Listensession. This function will make sure the
StartListening function, called when the protocols where succesfully binded, will return false. When (all) the
Clientsession(s), created by this ListenSession, are closed the CloseListenSession function exported by the protocols in the
ListenSession will be called. These functions should remove every recource previously allocated by the
BindToProtocolCallBack function.
Requirements
Should be exported by | Receiver, Transformer and Processor plugin. |
Minimum supported API | 1.00
|
Header | tvsserver_base.h |