• 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
  • InternalProtocolStructure structure

    Contains information about the protocol descriped in member psess.

    Syntax

    typedef struct InternalProtocolStructure{
    struct InternalProtocolStructure *nextProtocol;
    struct ProtocolSession *psess;
    struct ProtocolSession *copyPsess;
    void *reserved;
    void *reserved;
    struct LinkedlistControlPanelOptions *main;
    struct LinkedlistControlPanelOptions *subOptions;
    int status;
    int type;
    int highestSupportedVersion;
    int extraSize;
    void *reserved;
    void *reserved;
    struct ProtocolSignature *pSign[];
    void *reserved;
    } InternalProtocolStructure;

    Members

    nextProtocolpsesscopyPsessreservedreservedmainsubOptionsstatus
    ValueMeaning
    PT_STARTING
    0
    The protocol is loading.
    PT_PROTOCOLINFO_SET
    1
    The protocol is still loading, but already called the function SetProtocolInformation.
    PT_RUNNING
    2
    The protocol is successfully loaded.

    type
    ValueMeaning
    PT_RECEIVER
    0
    The protocol is a receiver (e.g. TCP/IP, Bluetooth). It should be able to establish a new connection with a client, receive data and send data to the client.
    PT_MANIPULATOR
    1
    The protocol is a transformer (e.g. SSL/ TLS). When a PT_LABORER protocol requires to receive or send data, this protocol should manipulate the data.
    PT_LABORER
    2
    The protocol is a processor (e.g. HTTP/SMTP/FTP).
    PT_NO_PROTOCOL
    3
    This is not a protocol but does other thing (like an updater).

    ValueMeaning
    PT_CONTROLPANEL
    0x10000
    The protocol wants the right to acces the settings of all the protocols and will be able to activate new protocols.
    PT_SUPPORT_PSIGN
    0x20000
    The protocol suppports the pSign parameter, please read the remark section for more information.

    ValueMeaning
    PT_SYSTEM_DEFAULT_CHARSET
    0x0
    The unicode strings passed by this protocol are in the default system charset.
    PT_ANSI_CHARSET
    0x40000
    The unicode strings passed by this protocol are in the ANSI charset.
    PT_MAC_CHARSET
    0x80000
    The unicode strings passed by this protocol are in the Macintosh charset.
    PT_UTF_8_CHARSET
    0x100000
    The unicode strings passed by this protocol are in the UTF-8 charset.

    highestSupportedVersion
    ValueMeaning
    V_TV_SERVER_1
    0
    A reference to API version 1.00 of TV's server.
    V_TV_SERVER_101
    1
    A reference to API version 1.01 of TV's server.

    extraSizereservedreservedpSignreserved

    Requirements

    Minimum supported API 1.00
    Header tvsserver_base
    .h