sofia-sip/sip.h File Reference

SIP objects. More...

#include <sofia-sip/msg_types.h>
#include <sofia-sip/msg_mime.h>

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_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...
Defines
#define	SIP_H
	Defined when <sofia-sip/sip.h> has been included.
#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.
typedef struct sip_s	sip_t
	Structure for accessing parsed SIP headers.
typedef union sip_header_u	sip_header_t
	Any SIP header - union of all possible SIP headers.
typedef struct msg_generic_s	sip_generic_t
	Type of a generic SIP header.
typedef msg_common_t	sip_common_t
	Common part of all the header structures.
typedef msg_param_t	sip_param_t
	SIP parameter string.
typedef struct sip_addr_s	sip_addr_t
	To or From header.
typedef msg_auth_t	sip_auth_t
	Authorization, Proxy-Authenticate, WWW-Authenticate
typedef struct sip_request_s	sip_request_t
	The structure sip_request_t contains representation of SIP request line.
typedef struct sip_status_s	sip_status_t
	The structure sip_status_t contains representation of SIP status line.
typedef msg_error_t	sip_error_t
	The structure sip_error_t contains representation of error headers.
typedef msg_unknown_t	sip_unknown_t
	The structure sip_unknown_t contains representation of unknown headers.
typedef msg_separator_t	sip_separator_t
	The structure sip_separator_t contains representation of separator line between message headers and body.
typedef msg_payload_t	sip_payload_t
	The structure sip_payload_t contains representation of SIP message payload.
typedef struct sip_accept_s	sip_accept_t
	The structure sip_accept_t contains representation of SIP Accept header.
typedef msg_accept_any_t	sip_accept_encoding_t
	The structure sip_accept_encoding_t contains representation of SIP Accept-Encoding header.
typedef msg_accept_any_t	sip_accept_language_t
	The structure sip_accept_language_t contains representation of SIP Accept-Language header.
typedef struct sip_allow_s	sip_allow_t
	The structure sip_allow_t contains representation of an Allow header.
typedef struct msg_auth_info_s	sip_authentication_info_t
	The structure sip_authentication_info_t contains representation of SIP Authentication-Info header.
typedef struct msg_auth_s	sip_authorization_t
	The structure sip_authorization_t contains representation of SIP Authorization header.
typedef struct sip_call_id_s	sip_call_id_t
	The structure sip_call_id_t contains representation of SIP Call-ID header.
typedef struct sip_call_info_s	sip_call_info_t
	The structure sip_call_info_t contains representation of an Call-Info header.
typedef struct sip_contact_s	sip_contact_t
	The structure sip_contact_t contains representation of SIP Contact header.
typedef struct sip_cseq_s	sip_cseq_t
	The structure sip_cseq_t contains representation of SIP CSeq header.
typedef struct msg_generic_s	sip_etag_t
	The structure sip_etag_t contains representation of a SIP SIP-ETag header.
typedef struct msg_generic_s	sip_if_match_t
	The structure sip_if_match_t contains representation of a SIP SIP-If-Match header.
typedef msg_content_disposition_t	sip_content_disposition_t
	The structure sip_content_disposition_t contains representation of an Content-Disposition header.
typedef msg_list_t	sip_content_encoding_t
	The structure sip_content_encoding_t contains representation of an Content-Encoding header.
typedef msg_list_t	sip_content_language_t
	The structure sip_content_language_t contains representation of Content-Language header.
typedef struct sip_content_length_s	sip_content_length_t
	The structure sip_content_length_t contains representation of SIP Content-Length header.
typedef struct msg_content_type_s	sip_content_type_t
	The structure sip_content_type_t contains representation of SIP Content-Type header.
typedef struct msg_generic_s	sip_mime_version_t
	The structure sip_mime_version_t contains representation of an MIME-Version header.
typedef struct sip_date_s	sip_date_t
	The structure sip_date_t contains representation of SIP Date header.
typedef struct sip_error_info_s	sip_error_info_t
	The structure sip_error_info_t contains representation of an Error-Info header.
typedef struct sip_expires_s	sip_expires_t
	The structure sip_expires_t contains representation of SIP Expires header.
typedef struct sip_addr_s	sip_from_t
	The structure sip_from_t contains representation of From header.
typedef msg_list_t	sip_in_reply_to_t
	The structure sip_in_reply_to_t contains representation of SIP In-Reply-To header.
typedef struct sip_max_forwards_s	sip_max_forwards_t
	The structure sip_max_forwards_t contains representation of SIP Max-Forwards header.
typedef struct sip_min_expires_s	sip_min_expires_t
	The structure sip_min_expires_t contains representation of SIP Min-Expires header.
typedef struct sip_min_se_s	sip_min_se_t
	The structure sip_min_se_t contains representation of the SIP Min-SE header.
typedef struct msg_generic_s	sip_organization_t
	The structure sip_organization_t contains representation of a SIP Organization header.
typedef struct msg_generic_s	sip_priority_t
	The structure sip_priority_t contains representation of a SIP Priority header.
typedef struct msg_auth_s	sip_proxy_authenticate_t
	The structure sip_proxy_authenticate_t contains representation of SIP Proxy-Authenticate header.
typedef struct msg_auth_info_s	sip_proxy_authentication_info_t
	The structure sip_proxy_authentication_info_t contains representation of SIP Proxy-Authentication-Info header.
typedef struct msg_auth_s	sip_proxy_authorization_t
	The structure sip_proxy_authorization_t contains representation of SIP Proxy-Authorization header.
typedef msg_list_t	sip_proxy_require_t
	The structure sip_proxy_require_t contains representation of an Proxy-Require header.
typedef struct sip_rack_s	sip_rack_t
	The structure sip_rack_t contains representation of an RAck header.
typedef struct sip_reason_s	sip_reason_t
	The structure sip_reason_t contains representation of SIP Reason header.
typedef struct sip_route_s	sip_record_route_t
	The structure sip_record_route_t contains representation of SIP Record-Route header.
typedef struct sip_refer_to_s	sip_refer_to_t
	The structure sip_refer_to_t contains representation of Refer-To header.
typedef struct sip_referred_by_s	sip_referred_by_t
	The structure sip_referred_by_t contains representation of Referred-By header.
typedef struct sip_replaces_s	sip_replaces_t
	The structure sip_replaces_t contains representation of Replaces header.
typedef struct sip_request_disposition_s	sip_request_disposition_t
	The structure sip_request_disposition_t contains representation of Request-Disposition header.
typedef struct sip_caller_prefs_s	sip_accept_contact_t
	The structure sip_accept_contact_t contains representation of SIP Accept-Contact header.
typedef struct sip_caller_prefs_s	sip_reject_contact_t
	The structure sip_reject_contact_t contains representation of SIP Reject-Contact header.
typedef msg_list_t	sip_require_t
	The structure sip_require_t contains representation of an Require header.
typedef struct sip_retry_after_s	sip_retry_after_t
	The structure sip_retry_after_t contains representation of an Retry-After header.
typedef struct sip_route_s	sip_route_t
	The structure sip_route_t contains representation of SIP Route header.
typedef struct sip_rseq_s	sip_rseq_t
	The structure sip_rseq_t contains representation of an RSeq header.
typedef struct msg_generic_s	sip_server_t
	The structure sip_server_t contains representation of a SIP Server header.
typedef struct sip_session_expires_s	sip_session_expires_t
	The structure sip_session_expires_t contains representation of the SIP Session-Expires header.
typedef struct msg_generic_s	sip_subject_t
	The structure sip_subject_t contains representation of a SIP Subject header.
typedef struct sip_subscription_state_s	sip_subscription_state_t
	The structure sip_subscription_state_t contains representation of an Subscription-State header.
typedef msg_list_t	sip_supported_t
	The structure sip_supported_t contains representation of an Supported header.
typedef struct sip_timestamp_s	sip_timestamp_t
	The structure sip_timestamp_t contains representation of a SIP Timestamp header.
typedef struct sip_addr_s	sip_to_t
	The structure sip_to_t contains representation of To header.
typedef msg_list_t	sip_unsupported_t
	The structure sip_unsupported_t contains representation of an Unsupported header.
typedef struct msg_generic_s	sip_user_agent_t
	The structure sip_user_agent_t contains representation of a SIP User-Agent header.
typedef struct sip_via_s	sip_via_t
	The structure sip_via_t contains representation of SIP Via header.
typedef msg_warning_t	sip_warning_t
	The structure sip_warning_t contains representation of an Warning header.
typedef struct msg_auth_s	sip_www_authenticate_t
	The structure sip_www_authenticate_t contains representation of SIP WWW-Authenticate header.
typedef struct sip_event_s	sip_event_t
	The structure sip_event_t contains representation of an Event header.
typedef msg_list_t	sip_allow_events_t
	The structure sip_allow_events_t contains representation of an Allow-Events header.
typedef struct sip_privacy_s	sip_privacy_t
	The structure sip_privacy_t contains representation of a SIP Privacy header.
typedef struct sip_route_s	sip_path_t
	The structure sip_path_t contains representation of SIP Path header.
typedef struct sip_security_agree_s	sip_security_client_t
	The structure sip_security_client_t contains representation of SIP Security-Client header.
typedef struct sip_security_agree_s	sip_security_server_t
	The structure sip_security_server_t contains representation of SIP Security-Server header.
typedef struct sip_security_agree_s	sip_security_verify_t
	The structure sip_security_verify_t contains representation of SIP Security-Verify header.
typedef struct sip_route_s	sip_service_route_t
	The structure sip_service_route_t contains representation of SIP Service-Route header.
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 }

---

Detailed Description

SIP objects.

Author:

Pekka Pessi <Pekka.Pessi@nokia-email.address.hidden>.

Date:

Created : Thu Jun 8 19:28:55 2000 ppessi

---

Define Documentation

#define SIP_H

Defined when <sofia-sip/sip.h> has been included.

---

Typedef Documentation

typedef struct sip_addr_s sip_addr_t

To or From header.

typedef msg_common_t sip_common_t

Common part of all the header structures.

typedef struct msg_generic_s sip_generic_t

Type of a generic SIP header.

typedef union sip_header_u sip_header_t

Any SIP header - union of all possible SIP headers.

typedef msg_param_t sip_param_t

SIP parameter string.

typedef struct sip_s sip_t

Structure for accessing parsed SIP headers.

typedef msg_time_t sip_time_t

Time in seconds since Jan 01 1900.

---

Enumeration Type Documentation

anonymous enum

Enumerator:

SIP_DEFAULT_PORT	Default port for SIP as integer.
SIP_DEFAULT_PORT	Default port for SIP as integer.

enum sip_method_t

IDs for well-known SIP methods.

Enumerator:

sip_method_invalid	Invalid method name.
sip_method_unknown	Unknown method, use method_name.
sip_method_invite	INVITE.
sip_method_ack	ACK.
sip_method_cancel	CANCEL.
sip_method_bye	BYE.
sip_method_options	OPTIONS.
sip_method_register	REGISTER.
sip_method_info	INFO.
sip_method_prack	PRACK.
sip_method_update	UPDATE.
sip_method_message	MESSAGE.
sip_method_subscribe	SUBSCRIBE.
sip_method_notify	NOTIFY.
sip_method_refer	REFER.
sip_method_publish	PUBLISH.