SIP objects. More...
Include dependency graph for sip.h:
Go to the source code of this file.
Data Structures | |
| struct | sip_s |
| SIP message object. More... | |
| struct | sip_request_s |
| Structure for SIP request line. More... | |
| struct | sip_status_s |
| Structure for SIP status line. More... | |
| struct | sip_addr_s |
| Structure for From and To headers. More... | |
| struct | sip_accept_s |
| Structure for Accept header field. More... | |
| struct | sip_allow_s |
| Structure for Allow header field. More... | |
| struct | sip_authentication_info_s |
| Structure for Authentication-Info header. More... | |
| struct | sip_call_id_s |
| Structure for Call-ID (and In-Reply-To) header fields. More... | |
| struct | sip_call_info_s |
| Structure for Call-Info header. More... | |
| struct | sip_cseq_s |
| Structure for CSeq header. More... | |
| struct | sip_identity_s |
| Structure for @Identity SIP header. More... | |
| struct | sip_contact_s |
| Structure for Contact header field. More... | |
| struct | sip_content_length_s |
| Structure for Content-Length header. More... | |
| struct | sip_content_type_s |
| Structure for Content-Type header. More... | |
| struct | sip_date_s |
| Structure for Date header. More... | |
| struct | sip_error_info_s |
| Structure for Error-Info header. More... | |
| struct | sip_event_s |
| Structure for Event header. More... | |
| struct | sip_expires_s |
| Structure for Expires header. More... | |
| struct | sip_max_forwards_s |
| Structure for Max-Forwards header. More... | |
| struct | sip_min_expires_s |
| Structure for Min-Expires header. More... | |
| struct | sip_rack_s |
| Structure for RAck header. More... | |
| struct | sip_refer_to_s |
| Structure for Refer-To header. More... | |
| struct | sip_referred_by_s |
| Structure for Referred-By header. More... | |
| struct | sip_replaces_s |
| Structure for Replaces header. More... | |
| struct | sip_retry_after_s |
| Structure for Retry-After header. More... | |
| struct | sip_request_disposition_s |
| Structure for Request-Disposition header. More... | |
| struct | sip_caller_prefs_s |
| Structure for Accept-Contact and Reject-Contact header fields. More... | |
| struct | sip_reason_s |
| Structure for Reason header field. More... | |
| struct | sip_route_s |
| Structure for Route and Record-Route header fields. More... | |
| struct | sip_rseq_s |
| Structure for RSeq header. More... | |
| struct | sip_session_expires_s |
| Structure for Session-Expires header. More... | |
| struct | sip_min_se_s |
| Structure for Min-SE header. More... | |
| struct | sip_subscription_state_s |
| Structure for Subscription-State header. More... | |
| struct | sip_timestamp_s |
| Structure for Timestamp header. More... | |
| struct | sip_via_s |
| Structure for Via header field. More... | |
| struct | sip_security_agree_s |
| Structure for Security-Client, Security-Server, and Security-Verify headers. More... | |
| struct | sip_privacy_s |
| Structure for Privacy header. More... | |
Macros | |
| #define | SIP_H |
| Defined when <sofia-sip/sip.h> has been included. More... | |
| #define | SIP_NONE |
| Magic pointer value - never valid for SIP headers. | |
| #define | SIP_PROTOCOL_TAG |
| SIP protocol identifier. | |
| #define | SIP_DEFAULT_SERV |
| Default port for SIP as string. | |
| #define | SIP_TIME_MAX |
| Latest time that can be expressed with sip_time_t. | |
Typedefs | |
| typedef msg_time_t | sip_time_t |
| Time in seconds since Jan 01 1900. More... | |
| typedef struct sip_s | sip_t |
| Structure for accessing parsed SIP headers. More... | |
| typedef union sip_header_u | sip_header_t |
| Any SIP header - union of all possible SIP headers. More... | |
| typedef struct msg_generic_s | sip_generic_t |
| Type of a generic SIP header. More... | |
| typedef msg_common_t | sip_common_t |
| Common part of all the header structures. More... | |
| typedef msg_param_t | sip_param_t |
| SIP parameter string. More... | |
| typedef struct sip_addr_s | sip_addr_t |
| To or From header. More... | |
| typedef msg_auth_t | sip_auth_t |
| Authorization, Proxy-Authenticate, WWW-Authenticate | |
| typedef struct sip_request_s | sip_request_t |
| @The request line is first line in a SIP request message. More... | |
| typedef struct sip_status_s | sip_status_t |
| @The status line is first line in a response message. More... | |
| typedef msg_error_t | sip_error_t |
| @The erroneous headers are stored in sip_error_t structure. More... | |
| typedef msg_unknown_t | sip_unknown_t |
| @The unknown headers are handled with sip_unknown_t structure. More... | |
| typedef msg_separator_t | sip_separator_t |
| @An empty line separates message headers from the message body (payload). More... | |
| typedef msg_payload_t | sip_payload_t |
| @The payload structure contains the optional message body. More... | |
| typedef struct sip_accept_s | sip_accept_t |
| @The Accept request-header field can be used to specify certain media types which are acceptable for the response. More... | |
| typedef msg_accept_any_t | sip_accept_encoding_t |
| @The Accept-Encoding header is similar to Accept, but restricts the content-codings that are acceptable in the response. More... | |
| typedef msg_accept_any_t | sip_accept_language_t |
| @The Accept-Language header can be used to allow the client to indicate to the server in which language it would prefer to receive reason phrases, session descriptions or status responses carried as message bodies. More... | |
| typedef struct sip_allow_s | sip_allow_t |
| @The Allow header lists the set of methods supported by the user agent generating the message. More... | |
| typedef struct msg_auth_info_s | sip_authentication_info_t |
| @The Authentication-Info header contains either a next-nonce used by next request and/or authentication from server used in mutual authentication. More... | |
| typedef struct msg_auth_s | sip_authorization_t |
| @The Authorization header consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. More... | |
| typedef struct sip_call_id_s | sip_call_id_t |
| @The Call-ID header uniquely identifies a particular invitation or all registrations of a particular client. More... | |
| typedef struct sip_call_info_s | sip_call_info_t |
| @The Call-Info header provides additional information about the caller or callee. More... | |
| typedef struct sip_contact_s | sip_contact_t |
| @The Contact header contain a list of URLs used to redirect future requests. More... | |
| typedef struct sip_cseq_s | sip_cseq_t |
| @The CSeq header (command sequence) uniquely identifies transactions within a dialog. More... | |
| typedef struct msg_generic_s | sip_etag_t |
| @The SIP-ETag header field identifies the published event state. More... | |
| typedef struct msg_generic_s | sip_if_match_t |
| @The SIP-If-Match header field identifies the specific entity of event state that the request is refreshing, modifying or removing. More... | |
| typedef msg_content_disposition_t | sip_content_disposition_t |
| @The Content-Disposition header field describes how the message body or, in the case of multipart messages, a message body part is to be interpreted by the UAC or UAS. More... | |
| typedef msg_list_t | sip_content_encoding_t |
| @The Content-Encoding header indicates what additional content codings have been applied to the entity-body. More... | |
| typedef msg_list_t | sip_content_language_t |
| @The Content-Language header RFC 2616 section 14.12 describes the natural language(s) of the intended audience for the enclosed entity. More... | |
| typedef struct sip_content_length_s | sip_content_length_t |
| @The Content-Length header indicates the size of the message-body in decimal number of octets. More... | |
| typedef struct msg_content_type_s | sip_content_type_t |
| @The Content-Type header indicates the media type of the message-body sent to the recipient. More... | |
| typedef struct msg_generic_s | sip_mime_version_t |
| @MIME-Version header indicates what version of the MIME protocol was used to construct the message. More... | |
| typedef struct sip_date_s | sip_date_t |
| @The Date header field reflects the time when the request or response was first sent. More... | |
| typedef struct sip_error_info_s | sip_error_info_t |
| @The Error-Info header provides a pointer to additional information about the error status response. More... | |
| typedef struct sip_expires_s | sip_expires_t |
| @The Expires header field gives the date and time after which the message content expires. More... | |
| typedef struct sip_addr_s | sip_from_t |
| @The From header indicates the initiator of the request. More... | |
| typedef msg_list_t | sip_in_reply_to_t |
| @The In-Reply-To request header field enumerates the Call-IDs that this call references or returns. More... | |
| typedef struct sip_max_forwards_s | sip_max_forwards_t |
| @The Max-Forwards header is used to limit the number of proxies or gateways that can forward the request. More... | |
| typedef struct sip_min_expires_s | sip_min_expires_t |
| @The Min-Expires header is used to limit the number of proxies or gateways that can forward the request. More... | |
| typedef struct sip_min_se_s | sip_min_se_t |
| @The Min-SE header is used to indicate the minimum value for the session interval. More... | |
| typedef struct msg_generic_s | sip_organization_t |
| @The Organization header field conveys the name of the organization to which the entity issuing the request or response belongs. More... | |
| typedef struct msg_generic_s | sip_priority_t |
| @The Priority request-header field indicates the urgency of the request as perceived by the client. More... | |
| typedef struct msg_auth_s | sip_proxy_authenticate_t |
| @The Proxy-Authenticate header consists of a challenge that indicates the authentication scheme and parameters applicable to the proxy. More... | |
| typedef struct msg_auth_info_s | sip_proxy_authentication_info_t |
| @The Proxy-Authentication-Info header contains either a next-nonce used by next request and/or authentication from proxy used in mutual authentication. More... | |
| typedef struct msg_auth_s | sip_proxy_authorization_t |
| @The Proxy-Authorization header consists of credentials containing the authentication information of the user agent for the proxy and/or realm of the resource being requested. More... | |
| typedef msg_list_t | sip_proxy_require_t |
| @The Proxy-Require header is used to indicate proxy-sensitive features that MUST be supported by the proxy. More... | |
| typedef struct sip_rack_s | sip_rack_t |
| @The RAck header indicates the sequence number of the provisional response which is being acknowledged. More... | |
| typedef struct sip_reason_s | sip_reason_t |
| @The Reason header is used to indicate why a SIP request was issued or why a provisional response was sent. More... | |
| typedef struct sip_route_s | sip_record_route_t |
| @The Record-Route headers are used to establish a route for transactions belonging to a session. More... | |
| typedef struct sip_refer_to_s | sip_refer_to_t |
| @The Refer-To header provides a URI to reference. More... | |
| typedef struct sip_referred_by_s | sip_referred_by_t |
| @The Referred-By header conveys the identity of the original referrer to the referred-to party. More... | |
| typedef struct sip_replaces_s | sip_replaces_t |
| @The Replaces header indicates that a single dialog identified by the header field is to be shut down and logically replaced by the incoming INVITE in which it is contained. More... | |
| typedef struct sip_request_disposition_s | sip_request_disposition_t |
| @The Request-Disposition header syntax is defined in RFC 3841 section 10 as follows: More... | |
| typedef struct sip_caller_prefs_s | sip_accept_contact_t |
| @The Accept-Contact syntax is defined in RFC 3841 section 10 as follows: More... | |
| typedef struct sip_caller_prefs_s | sip_reject_contact_t |
| @The Reject-Contact syntax is defined in RFC 3841 section 10 as follows: More... | |
| typedef msg_list_t | sip_require_t |
| @The Require header is used by clients to tell user agent servers about options that the client expects the server to support in order to properly process the request. More... | |
| typedef struct sip_retry_after_s | sip_retry_after_t |
| @The Retry-After response-header field RFC 3261 section 20.33 can be used to indicate how long the service is expected to be unavailable or when the called party anticipates being available again. More... | |
| typedef struct sip_route_s | sip_route_t |
| @The Route headers is used to store the route set of a transaction. More... | |
| typedef struct sip_rseq_s | sip_rseq_t |
| @The RSeq header identifies provisional responses within a transaction. More... | |
| typedef struct msg_generic_s | sip_server_t |
| @The Server response-header field contains information about the software used by the user agent server to handle the request. More... | |
| typedef struct sip_session_expires_s | sip_session_expires_t |
| @The Session-Expires header is used to convey the lifetime of the session. More... | |
| typedef struct msg_generic_s | sip_subject_t |
| @The Subject header provides a summary or indicates the nature of the request. More... | |
| typedef struct sip_subscription_state_s | sip_subscription_state_t |
| @The Subscription-State header is used to indicate in which state a subscription is. More... | |
| typedef msg_list_t | sip_supported_t |
| @The Supported header enumerates all the capabilities of the client or server. More... | |
| typedef struct sip_timestamp_s | sip_timestamp_t |
| @The Timestamp header describes when the client sent the request to the server, and it is used by the client to adjust its retransmission intervals. More... | |
| typedef struct sip_addr_s | sip_to_t |
| @The To header field specifies the "logical" recipient of the request. More... | |
| typedef msg_list_t | sip_unsupported_t |
| @The Unsupported header lists the features not supported by the server. More... | |
| typedef struct msg_generic_s | sip_user_agent_t |
| @The User-Agent header contains information about the client user agent originating the request. More... | |
| typedef struct sip_via_s | sip_via_t |
| @The Via header indicates the path taken by the request so far. More... | |
| typedef msg_warning_t | sip_warning_t |
| @The Warning response-header field is used to carry additional information about the status of a response. More... | |
| typedef struct msg_auth_s | sip_www_authenticate_t |
| @The WWW-Authenticate header consists of at least one challenge that indicates the authentication scheme(s) and parameters applicable to the Request-URI. More... | |
| typedef struct sip_event_s | sip_event_t |
| @The Event header is used to indicate the which event or class of events the message contains or subscribes. More... | |
| typedef msg_list_t | sip_allow_events_t |
| @The Allow-Events header is used to indicate which events or classes of events the notifier supports. More... | |
| typedef struct sip_privacy_s | sip_privacy_t |
| @The Privacy header is used by User-Agent to request privacy services from the network. More... | |
| typedef struct sip_identity_s | sip_identity_t |
| @The Identity header field specifies the "logical" recipient of the request. More... | |
| typedef struct sip_route_s | sip_path_t |
| @The Path header field is a SIP extension header field (RFC 3327) with syntax very similar to the Record-Route header field. More... | |
| typedef struct sip_security_agree_s | sip_security_client_t |
| @The Security-Client header is defined by RFC 3329, "Security Mechanism
Agreement for the Session Initiation Protocol (SIP)". More... | |
| typedef struct sip_security_agree_s | sip_security_server_t |
| @The Security-Server header is defined by RFC 3329, "Security Mechanism
Agreement for the Session Initiation Protocol (SIP)". More... | |
| typedef struct sip_security_agree_s | sip_security_verify_t |
| @The Security-Verify header is defined by RFC 3329, "Security Mechanism
Agreement for the Session Initiation Protocol (SIP)". More... | |
| typedef struct sip_route_s | sip_service_route_t |
| @The "Service-Route" is a SIP extension header field (RFC 3608), which can contain a route vector that will direct requests through a specific sequence of proxies. More... | |
Enumerations | |
| enum | sip_method_t { sip_method_invalid, sip_method_unknown, sip_method_invite, sip_method_ack, sip_method_cancel, sip_method_bye, sip_method_options, sip_method_register, sip_method_info, sip_method_prack, sip_method_update, sip_method_message, sip_method_subscribe, sip_method_notify, sip_method_refer, sip_method_publish } |
| IDs for well-known SIP methods. More... | |
| enum | { SIP_DEFAULT_PORT, SIP_DEFAULT_PORT, SIPS_DEFAULT_PORT } |
Detailed Description
SIP objects.
- Date
- Created : Thu Jun 8 19:28:55 2000 ppessi
Macro Definition Documentation
◆ SIP_H
| #define SIP_H |
Defined when <sofia-sip/sip.h> has been included.
Typedef Documentation
◆ sip_addr_t
| typedef struct sip_addr_s sip_addr_t |
◆ sip_common_t
| typedef msg_common_t sip_common_t |
Common part of all the header structures.
◆ sip_generic_t
| typedef struct msg_generic_s sip_generic_t |
Type of a generic SIP header.
◆ sip_header_t
| typedef union sip_header_u sip_header_t |
Any SIP header - union of all possible SIP headers.
◆ sip_param_t
| typedef msg_param_t sip_param_t |
SIP parameter string.
◆ sip_t
◆ sip_time_t
| typedef msg_time_t sip_time_t |
Time in seconds since Jan 01 1900.
Enumeration Type Documentation
◆ anonymous enum
| anonymous enum |
◆ sip_method_t
| enum sip_method_t |
IDs for well-known SIP methods.