?? osip_parser.h
字號:
/* The oSIP library implements the Session Initiation Protocol (SIP -rfc2543-) Copyright (C) 2001 Aymeric MOIZARD jack@atosc.org This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA*/#ifndef _OSIP_PARSER_H_#define _OSIP_PARSER_H_#include <osipparser2/osip_message.h>/** * @file osip_parser.h * @brief oSIP SIP Parser additionnal Routines * *//** * @defgroup oSIP_PARSER oSIP parser Handling * @ingroup oSIP * @{ */#ifdef __cplusplusextern "C"{#endif/** * Initialise the oSIP parser. */ int parser_init ();/** * Fix the via header for INCOMING requests only. * a copy of ip_addr is done. */ int osip_message_fix_last_via_header (osip_message_t * request, const char *ip_addr, int port);/** * define this macro to avoid building several times * the message on retransmissions. If you have changed * the osip_message_t element since last call of osip_message_to_str() you * can call osip_message_force_update() to force a rebuild.*/#ifdef USE_TMP_BUFFER/** * Check if the element is already built. (so osip_message_to_str won't build it again) * @param sip The element to check.*/ int osip_message_get__property (const osip_message_t * sip);#endif/** * Force a osip_message_t element to be rebuild on next osip_message_to_str() call. * @param sip The element to work on. */ int osip_message_force_update (osip_message_t * sip);/** * Get the usual reason phrase as defined in SIP for a specific status code. * @param status_code A status code. */ const char *osip_message_get_reason (int status_code);/** * Set the Accept header. * @param sip The element to work on. * @param hvalue The string describing the element. */ int osip_message_set_accept (osip_message_t * sip, const char *hvalue);/** * Get one Accept header. * @param sip The element to work on. * @param pos The index of the element to get. * @param dest A pointer on the header found. */ int osip_message_get_accept (const osip_message_t * sip, int pos, osip_accept_t ** dest);/** * Set the Accept-encoding header. * @param sip The element to work on. * @param hvalue The string describing the element. */ int osip_message_set_accept_encoding (osip_message_t * sip, const char *hvalue);/** * Get one Accept-encoding header. * @param sip The element to work on. * @param pos The index of the element to get. * @param dest A pointer on the header found. */ int osip_message_get_accept_encoding (const osip_message_t * sip, int pos, osip_accept_encoding_t ** dest);/** * Set the Accept-language header. * @param sip The element to work on. * @param hvalue The string describing the element. */ int osip_message_set_accept_language (osip_message_t * sip, const char *hvalue);/** * Get one Accept header. * @param sip The element to work on. * @param pos The index of the element to get. * @param dest A pointer on the header found. */ int osip_message_get_accept_language (const osip_message_t * sip, int pos, osip_accept_language_t ** dest);/** * Set the Alert-info header. * @param sip The element to work on. * @param hvalue The string describing the element. */ int osip_message_set_alert_info (osip_message_t * sip, const char *hvalue);/** * Get one Alert-info header. * @param sip The element to work on. * @param pos The index of the element to get. * @param dest A pointer on the header found. */ int osip_message_get_alert_info (const osip_message_t * sip, int pos, osip_alert_info_t ** dest);/** * Set the Allow header. * @param sip The element to work on. * @param hvalue The string describing the element. */ int osip_message_set_allow (osip_message_t * sip, const char *hvalue);/** * Get one Allow header. * @param sip The element to work on. * @param pos The index of the element to get. * @param dest A pointer on the header found. */ int osip_message_get_allow (const osip_message_t * sip, int pos, osip_allow_t ** dest);/** * Set the Authorization header. * @param sip The element to work on. * @param hvalue The string describing the element. */ int osip_message_set_authorization (osip_message_t * sip, const char *hvalue);/** * Get one Authorization header. * @param sip The element to work on. * @param pos The index of the element to get. * @param dest A pointer on the header found. */ int osip_message_get_authorization (const osip_message_t * sip, int pos, osip_authorization_t ** dest);/** * Set the Call-id header. * @param sip The element to work on. * @param hvalue The string describing the element. */ int osip_message_set_call_id (osip_message_t * sip, const char *hvalue);/** * Get one Call-id header. * @param sip The element to work on. */ osip_call_id_t *osip_message_get_call_id (const osip_message_t * sip);/** * Set the Call-info header. * @param sip The element to work on. * @param hvalue The string describing the element. */ int osip_message_set_call_info (osip_message_t * sip, const char *hvalue);/** * Get one Call-info header. * @param sip The element to work on. * @param pos The index of the element to get. * @param dest A pointer on the header found. */ int osip_message_get_call_info (const osip_message_t * sip, int pos, osip_call_info_t ** dest);/** * Set the Contact header. * @param sip The element to work on. * @param hvalue The string describing the element. */ int osip_message_set_contact (osip_message_t * sip, const char *hvalue);/** * Get one Contact header. * @param sip The element to work on. * @param pos The index of the element to get. * @param dest A pointer on the header found. */ int osip_message_get_contact (const osip_message_t * sip, int pos, osip_contact_t ** dest);/** * Set the Content-disposition header. * @param sip The element to work on. * @param hvalue The string describing the element. */ int osip_message_set_content_disposition (osip_message_t * sip, const char *hvalue);/** * Get one Content-disposition header. * @param sip The element to work on. * @param pos The index of the element to get. * @param dest A pointer on the header found. */ int osip_message_get_content_disposition (const osip_message_t * sip, int pos, osip_content_disposition_t ** dest);/** * Set the Content-encoding header. * @param sip The element to work on. * @param hvalue The string describing the element. */ int osip_message_set_content_encoding (osip_message_t * sip, const char *hvalue);/** * Get one Content-encoding header. * @param sip The element to work on. * @param pos The index of the element to get. * @param dest A pointer on the header found. */ int osip_message_get_content_encoding (const osip_message_t * sip, int pos, osip_content_encoding_t ** dest);/** * Set the Content-length header. * @param sip The element to work on. * @param hvalue The string describing the element. */ int osip_message_set_content_length (osip_message_t * sip, const char *hvalue);/** * Get one Content-length header. * @param sip The element to work on. */ osip_content_length_t *osip_message_get_content_length (const osip_message_t * sip);/** * Set the Content-type header. * @param sip The element to work on. * @param hvalue The string describing the element. */ int osip_message_set_content_type (osip_message_t * sip, const char *hvalue);/** * Get one Content-type header. * @param sip The element to work on. */ osip_content_type_t *osip_message_get_content_type (const osip_message_t * sip);/** * Set the Cseq header. * @param sip The element to work on. * @param hvalue The string describing the element. */ int osip_message_set_cseq (osip_message_t * sip, const char *hvalue);/** * Get one Cseq header. * @param sip The element to work on. */ osip_cseq_t *osip_message_get_cseq (const osip_message_t * sip);/** * Set the Error-info header. * @param sip The element to work on. * @param hvalue The string describing the element. */ int osip_message_set_error_info (osip_message_t * sip, const char *hvalue);/** * Get one Error-info header. * @param sip The element to work on. * @param pos The index of the element to get. * @param dest A pointer on the header found. */ int osip_message_get_error_info (const osip_message_t * sip, int pos, osip_error_info_t ** dest);/** * Set the From header. * @param sip The element to work on. * @param hvalue The string describing the element. */ int osip_message_set_from (osip_message_t * sip, const char *hvalue);/** * Get the From header. * @param sip The element to work on. */ osip_from_t *osip_message_get_from (const osip_message_t * sip);/** * Set the mime-version header. * @param sip The element to work on. * @param hvalue The string describing the element. */ int osip_message_set_mime_version (osip_message_t * sip, const char *hvalue);/** * Get the Mime-version header. * @param sip The element to work on. */ osip_mime_version_t *osip_message_get_mime_version (const osip_message_t * sip);/** * Set the Proxy-authenticate header. * @param sip The element to work on. * @param hvalue The string describing the element. */ int osip_message_set_proxy_authenticate (osip_message_t * sip, const char *hvalue);/** * Get the Proxy-authenticate header. * @param sip The element to work on. * @param pos The index of the element to get. * @param dest A pointer on the header found. */ int osip_message_get_proxy_authenticate (const osip_message_t * sip, int pos, osip_proxy_authenticate_t ** dest);/** * Set the Proxy-authorization header. * @param sip The element to work on. * @param hvalue The string describing the element. */ int osip_message_set_proxy_authorization (osip_message_t * sip, const char *hvalue);/** * Get one Proxy-authorization header. * @param sip The element to work on. * @param pos The index of the element to get. * @param dest A pointer on the header found. */ int osip_message_get_proxy_authorization (const osip_message_t * sip, int pos, osip_proxy_authorization_t ** dest);/** * Set the Record-Route header. * @param sip The element to work on. * @param hvalue The string describing the element. */ int osip_message_set_record_route (osip_message_t * sip, const char *hvalue);/** * Get one Record-route header. * @param sip The element to work on. * @param pos The index of the element to get. * @param dest A pointer on the header found. */ int osip_message_get_record_route (const osip_message_t * sip, int pos, osip_record_route_t ** dest);/** * Set the Route header. * @param sip The element to work on. * @param hvalue The string describing the element. */ int osip_message_set_route (osip_message_t * sip, const char *hvalue);/** * Get one Route header. * @param sip The element to work on. * @param pos The index of the element to get. * @param dest A pointer on the header found. */ int osip_message_get_route (const osip_message_t * sip, int pos, osip_route_t ** dest);/** * Set the To header. * @param sip The element to work on. * @param hvalue The string describing the element. */ int osip_message_set_to (osip_message_t * sip, const char *hvalue);/**
?? 快捷鍵說明
復制代碼
Ctrl + C
搜索代碼
Ctrl + F
全屏模式
F11
切換主題
Ctrl + Shift + D
顯示快捷鍵
?
增大字號
Ctrl + =
減小字號
Ctrl + -