Table of contents

General

• LIBSIP++ Columbia SIP library in C++
  • API Documentation
    • Common objects common for SIP and H.323
      • Addresses IptelAddress for URI, H323 ID, etc.
        • IptelAddress list
      • Call and endpoint IptelCall and IptelEndpoint interfaces
      • Media capabilities
        • SessionFormat list
        • SessionMedia list
    • SIP control objects Transaction, dialog, endpoint, call, etc.
      • Default SIP port number. macro
      • Transaction objects Transaction and libsip interface
        • Callback functions from the libsip C library
          • CanHandleRequest
          • HandleRequestLocally
          • OnEndToEndAck
          • OnIncomingAck
          • OnIncomingRequest
          • UseTransactionTable
    • SIP data objects Headers, messages, etc.
      • SIP message header classes.
        • SIPHeader list
      • SIP message specific classes.
  • Introduction
    • Architecture overview
    • Design philosophy
    • History
  • Using the library
    • Advanced media Audio, video, data
    • Authentication
    • Basic call
    • Changing media re-INVITE handling
    • General guidelines
    • Instant messaging
    • More examples
    • Presence extension Example on extending the library
    • Registration

Classes

• AFIAddress AFIAddress: address family independent IP endpoint addresses (host and port)
• IptelAddress IptelAddress: is a string used for storing addresses, for example, self address, remote address, etc
• IptelCall IptelCall: represents a call
• IptelEndpoint IptelEndpoint: represents a protocol server or client A server will be listening for incoming calls
• SessionDescription SessionDescription: contains list of session information
• SessionFormat This defines the payload type and definitions of the payload types
• SessionMedia SessionMedia: Used to store information about a session
• SIPAddressHeader The headers that can value the address

• SIPAuthenticateHeader Authenticate header used for WWW-Authenticate and Proxy-Authenticate

• SIPAuthorizationHeader Authorization header used for Authorization and ProxyAuthorization

• SIPCall This represents a SIP call between self and remote
• SIPClientTransaction SIPClientTransaction object represents a client transaction
• SIPContactHeader The Contact header

• SIPCSeqHeader The CSeq header
• SIPDate Specify the date information in absolute time, string or relative number of seconds
• SIPDateHeader The Date kind of headers

• SIPDialog This represents a SIP dialog or call leg
• SIPEndpoint This represents an endpoint, for example, a SIP user agent
• SIPHeader The SipHeader class is a generic SIP header
• SIPIntegerHeader The SIPInteger headers can be used for Content-Length, MaxForwards etc, but not for CSeq
• SIPLibrary This represents the library factory for configuration
• SIPMessage A generic SIP message to store the first line (request/response), set of headers and the message body
• SIPMessageBody The SIP Body

• SIPOutgoingRegister This represents an outgoing registration session
• SIPRequestMessage The request message
• SIPResponseMessage The response message

• SIPServerTransaction SIPServerTransaction object represents a server transaction
• SIPSession This represents an advanced SIP call session, between self and remote
• SIPSessionEndpoint This represents an advanced endpoint object that can invoke and create the SIPSession object
• SIPTransaction SIPTransaction object is a one-to-one mapping between the userapi policy for handling UA transactions

Functions, Macros

• lock_dialog Lock the dialog object
• lock_dialogs Lock the list of dialog objects
• unlock_dialog Un-lock the dialog object
• unlock_dialogs Unlock the list of dialog objects

Variables

• IptelAddressList IptelAddressList is a list of IptelAddresses
• IptelAddressListConstIterator IptelAddressListConstIterator is const_iterator of IptelAddressMediaList
• IptelAddressListIterator IptelAddressListIterator is iterator of IptelAddressList
• SessionFormatList SessionFormatList is a list of SessionFormat
• SessionFormatListConstIterator SessionFormatListConstIterator is a const_iterator for the list
• SessionFormatListIterator SessionFormatListIterator is an iterator for the list
• SESSIONID SESSIONID datatype: defined for easy portablity
• SessionMediaList SessionMediaList is list of SessionMedia
• SessionMediaListConstIterator SessionMediaListConstIterator is const_iterator of SessionMediaList
• SessionMediaListIterator SessionMediaListIterator is iterator of SessionMediaList
• SIPHeaderList List of SIPHeader used inside a message
• SIPHeaderListConstIterator Const Iterator for SIPHeaderList
• SIPHeaderListIterator Iterator for SIPHeaderList

Enums, Unions, Structs

• policy_info_t The userapi_policy's outgoing_policy_info_t is just a array (vector) of contact header locations to be searched and the associated transaction pointer

generated by doc++