• About TV's server
  • New in version 3.10
  • About the source code
  • About protocols/plugins
  • TV's server API
  • Protocol Initialisation
  • Protocol binding
  • Protocol Listening and handling
  • Protocol data storage
  • Control panel
  • Multi column list
  • Time and date
  • Http protocol functions
  • Unimplemented and/or replaced functions
  • 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]lsess [in]

    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