osip_parser.h

Go to the documentation of this file.

/*
  The oSIP library implements the Session Initiation Protocol (SIP -rfc3261-)
  Copyright (C) 2001-2020 Aymeric MOIZARD amoizard@antisip.com
 
  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>
 
#ifdef __cplusplus
extern "C" {
#endif
 
int parser_init(void);
 
int parser_add_comma_separated_header(const char *hname);
 
int osip_message_fix_last_via_header(osip_message_t *request, const char *ip_addr, int port);
 
int osip_message_get__property(const osip_message_t *sip);
 
int osip_message_force_update(osip_message_t *sip);
 
const char *osip_message_get_reason(int status_code);
 
#ifndef MINISIZE
int osip_message_set_accept(osip_message_t *sip, const char *hvalue);
#else
#define osip_message_set_accept(sip, value) osip_message_set_header((osip_message_t *) sip, (const char *) "Accept", value)
#endif
#ifndef MINISIZE
int osip_message_get_accept(const osip_message_t *sip, int pos, osip_accept_t **dest);
#else
#define osip_message_get_accept(sip, pos, dest) osip_message_header_get_byname((osip_message_t *) sip, (const char *) "accept", pos, (osip_header_t **) dest)
#endif
#ifndef MINISIZE
int osip_message_set_accept_encoding(osip_message_t *sip, const char *hvalue);
#else
#define osip_message_set_accept_encoding(sip, value) osip_message_set_header((osip_message_t *) sip, (const char *) "Accept-Encoding", value)
#endif
#ifndef MINISIZE
int osip_message_get_accept_encoding(const osip_message_t *sip, int pos, osip_accept_encoding_t **dest);
#else
#define osip_message_get_accept_encoding(sip, pos, dest) osip_message_header_get_byname((osip_message_t *) sip, (const char *) "accept-encoding", pos, (osip_header_t **) dest)
#endif
#ifndef MINISIZE
int osip_message_set_accept_language(osip_message_t *sip, const char *hvalue);
#else
#define osip_message_set_accept_language(sip, value) osip_message_set_header((osip_message_t *) sip, (const char *) "Accept-Language", value)
#endif
#ifndef MINISIZE
int osip_message_get_accept_language(const osip_message_t *sip, int pos, osip_accept_language_t **dest);
#else
#define osip_message_get_accept_language(sip, pos, dest) osip_message_header_get_byname((osip_message_t *) sip, (const char *) "accept-language", pos, (osip_header_t **) dest)
#endif
#ifndef MINISIZE
int osip_message_set_alert_info(osip_message_t *sip, const char *hvalue);
#else
#define osip_message_set_alert_info(sip, value) osip_message_set_header((osip_message_t *) sip, (const char *) "Alert-Info", value)
#endif
#ifndef MINISIZE
int osip_message_get_alert_info(const osip_message_t *sip, int pos, osip_alert_info_t **dest);
#else
#define osip_message_get_alert_info(sip, pos, dest) osip_message_header_get_byname((osip_message_t *) sip, (const char *) "alert-info", pos, (osip_header_t **) dest)
#endif
#ifndef MINISIZE
int osip_message_set_allow(osip_message_t *sip, const char *hvalue);
#else
#define osip_message_set_allow(sip, value) osip_message_set_header((osip_message_t *) sip, (const char *) "Allow", value)
#endif
#ifndef MINISIZE
int osip_message_get_allow(const osip_message_t *sip, int pos, osip_allow_t **dest);
#else
#define osip_message_get_allow(sip, pos, dest) osip_message_header_get_byname((osip_message_t *) sip, (const char *) "allow", pos, (osip_header_t **) dest)
#endif
#ifndef MINISIZE
int osip_message_set_authentication_info(osip_message_t *sip, const char *hvalue);
#else
#define osip_message_set_authentication_info(sip, value) osip_message_set_header((osip_message_t *) sip, (const char *) "Authentication-Info", value)
#endif
#ifndef MINISIZE
int osip_message_get_authentication_info(const osip_message_t *sip, int pos, osip_authentication_info_t **dest);
#else
#define osip_message_get_authentication_info(sip, pos, dest) osip_message_header_get_byname((osip_message_t *) sip, (const char *) "authentication-info", pos, (osip_header_t **) dest)
#endif
int osip_message_set_authorization(osip_message_t *sip, const char *hvalue);
#ifndef MINISIZE
int osip_message_get_authorization(const osip_message_t *sip, int pos, osip_authorization_t **dest);
#else
#define osip_message_get_authorization(sip, pos, dest) osip_message_get_knownheaderlist((&(sip)->authorizations), pos, (void **) (dest))
#endif
int osip_message_set_call_id(osip_message_t *sip, const char *hvalue);
#ifndef MINISIZE
osip_call_id_t *osip_message_get_call_id(const osip_message_t *sip);
#else
#define osip_message_get_call_id(sip) ((sip)->call_id)
#endif
int osip_message_set_call_info(osip_message_t *sip, const char *hvalue);
int osip_message_get_call_info(const osip_message_t *sip, int pos, osip_call_info_t **dest);
int osip_message_set_contact(osip_message_t *sip, const char *hvalue);
#ifndef MINISIZE
int osip_message_get_contact(const osip_message_t *sip, int pos, osip_contact_t **dest);
#else
#define osip_message_get_contact(sip, pos, dest) osip_message_get_knownheaderlist((&(sip)->contacts), pos, (void **) (dest))
#endif
#ifndef MINISIZE
int osip_message_set_content_encoding(osip_message_t *sip, const char *hvalue);
#else
#define osip_message_set_content_encoding(sip, value) osip_message_set_header((osip_message_t *) sip, (const char *) "Content-Encoding", value)
#endif
#ifndef MINISIZE
int osip_message_get_content_encoding(const osip_message_t *sip, int pos, osip_content_encoding_t **dest);
#else
#define osip_message_get_content_encoding(sip, pos, dest) osip_message_header_get_byname((osip_message_t *) sip, (const char *) "content-encoding", pos, (osip_header_t **) dest)
#endif
int osip_message_set_content_length(osip_message_t *sip, const char *hvalue);
#ifndef MINISIZE
osip_content_length_t *osip_message_get_content_length(const osip_message_t *sip);
#else
#define osip_message_get_content_length(sip) ((sip)->content_length)
#endif
int osip_message_set_content_type(osip_message_t *sip, const char *hvalue);
#ifndef MINISIZE
osip_content_type_t *osip_message_get_content_type(const osip_message_t *sip);
#else
#define osip_message_get_content_type(sip) ((sip)->content_type)
#endif
int osip_message_set_cseq(osip_message_t *sip, const char *hvalue);
#ifndef MINISIZE
osip_cseq_t *osip_message_get_cseq(const osip_message_t *sip);
#else
#define osip_message_get_cseq(sip) ((sip)->cseq)
#endif
#ifndef MINISIZE
int osip_message_set_error_info(osip_message_t *sip, const char *hvalue);
#else
#define osip_message_set_error_info(sip, value) osip_message_set_header((osip_message_t *) sip, (const char *) "Error-Info", value)
#endif
#ifndef MINISIZE
int osip_message_get_error_info(const osip_message_t *sip, int pos, osip_error_info_t **dest);
#else
#define osip_message_get_error_info(sip, pos, dest) osip_message_header_get_byname((osip_message_t *) sip, (const char *) "error-info", pos, (osip_header_t **) dest)
#endif
int osip_message_set_from(osip_message_t *sip, const char *hvalue);
#ifndef MINISIZE
osip_from_t *osip_message_get_from(const osip_message_t *sip);
#else
#define osip_message_get_from(sip) ((sip)->from)
#endif
int osip_message_set_mime_version(osip_message_t *sip, const char *hvalue);
#ifndef MINISIZE
osip_mime_version_t *osip_message_get_mime_version(const osip_message_t *sip);
#else
#define osip_message_get_mime_version(sip) ((sip)->mime_version)
#endif
int osip_message_set_proxy_authenticate(osip_message_t *sip, const char *hvalue);
#ifndef MINISIZE
int osip_message_get_proxy_authenticate(const osip_message_t *sip, int pos, osip_proxy_authenticate_t **dest);
#else
#define osip_message_get_proxy_authenticate(sip, pos, dest) osip_message_get_knownheaderlist((&(sip)->proxy_authenticates), pos, (void **) (dest))
#endif
int osip_message_set_proxy_authorization(osip_message_t *sip, const char *hvalue);
#ifndef MINISIZE
int osip_message_get_proxy_authorization(const osip_message_t *sip, int pos, osip_proxy_authorization_t **dest);
#else
#define osip_message_get_proxy_authorization(sip, pos, dest) osip_message_get_knownheaderlist((&(sip)->proxy_authorizations), pos, (void **) (dest))
#endif
#ifndef MINISIZE
int osip_message_set_proxy_authentication_info(osip_message_t *sip, const char *hvalue);
#else
#define osip_message_set_proxy_authentication_info(sip, value) osip_message_set_header((osip_message_t *) sip, (const char *) "Proxy-Authentication-Info", value)
#endif
#ifndef MINISIZE
int osip_message_get_proxy_authentication_info(const osip_message_t *sip, int pos, osip_proxy_authentication_info_t **dest);
#else
#define osip_message_get_proxy_authentication_info(sip, pos, dest) osip_message_header_get_byname((osip_message_t *) sip, (const char *) "proxy-authentication-info", pos, (osip_header_t **) dest)
#endif
int osip_message_set_record_route(osip_message_t *sip, const char *hvalue);
#ifndef MINISIZE
int osip_message_get_record_route(const osip_message_t *sip, int pos, osip_record_route_t **dest);
#else
#define osip_message_get_record_route(sip, pos, dest) osip_message_get_knownheaderlist((&(sip)->record_routes), pos, (void **) (dest))
#endif
int osip_message_set_route(osip_message_t *sip, const char *hvalue);
#ifndef MINISIZE
int osip_message_get_route(const osip_message_t *sip, int pos, osip_route_t **dest);
#else
#define osip_message_get_route(sip, pos, dest) osip_message_get_knownheaderlist((&(sip)->routes), pos, (void **) (dest))
#endif
int osip_message_set_to(osip_message_t *sip, const char *hvalue);
#ifndef MINISIZE
osip_to_t *osip_message_get_to(const osip_message_t *sip);
#else
#define osip_message_get_to(sip) ((sip)->to)
#endif
int osip_message_set_via(osip_message_t *sip, const char *hvalue);
int osip_message_append_via(osip_message_t *sip, const char *hvalue);
#ifndef MINISIZE
int osip_message_get_via(const osip_message_t *sip, int pos, osip_via_t **dest);
#else
#define osip_message_get_via(sip, pos, dest) osip_message_get_knownheaderlist((&(sip)->vias), pos, (void **) (dest))
#endif
int osip_message_set_www_authenticate(osip_message_t *sip, const char *hvalue);
#ifndef MINISIZE
int osip_message_get_www_authenticate(const osip_message_t *sip, int pos, osip_www_authenticate_t **dest);
#else
#define osip_message_get_www_authenticate(sip, pos, dest) osip_message_get_knownheaderlist((&(sip)->www_authenticates), pos, (void **) (dest))
#endif
#ifndef DOXYGEN
int osip_message_set_multiple_header(osip_message_t *sip, char *hname, char *hvalue);
#endif
int osip_message_set_header(osip_message_t *sip, const char *hname, const char *hvalue);
int osip_message_replace_header(osip_message_t *sip, const char *hname, const char *hvalue);
#ifndef MINISIZE
int osip_message_set_topheader(osip_message_t *sip, const char *hname, const char *hvalue);
#endif
int osip_message_header_get_byname(const osip_message_t *sip, const char *hname, int pos, osip_header_t **dest);
#ifndef MINISZE
int osip_message_get_header(const osip_message_t *sip, int pos, osip_header_t **dest);
#else
#define osip_message_get_header(sip, pos, dest) osip_message_get_knownheaderlist((&(sip)->headers), pos, (void **) (dest))
#endif
int osip_message_set_body(osip_message_t *sip, const char *buf, size_t length);
int osip_message_set_body_mime(osip_message_t *sip, const char *buf, size_t length);
#ifndef MINISIZE
int osip_message_get_body(const osip_message_t *sip, int pos, osip_body_t **dest);
#else
#define osip_message_get_body(sip, pos, dest) osip_message_get_knownheaderlist((&(sip)->bodies), pos, (void **) (dest))
#endif
 
/* trace facilities */
#ifndef DOXYGEN /* avoid DOXYGEN warning */
#ifdef ENABLE_TRACE
void msg_logrequest(osip_message_t *sip, char *fmt);
void msg_logresponse(osip_message_t *sip, char *fmt);
#else
#define msg_logrequest(P, Q) ;
#define msg_logresponse(P, Q) ;
#endif
#endif
 
#define osip_message_set_date(sip, value) osip_message_set_header((osip_message_t *) sip, (const char *) "Date", value)
#define osip_message_get_date(sip, pos, dest) osip_message_header_get_byname((osip_message_t *) sip, (const char *) "date", pos, (osip_header_t **) dest)
#define osip_message_set_encryption(sip, value) osip_message_set_header((osip_message_t *) sip, (const char *) "Encryption", value)
#define osip_message_get_encryption(sip, pos, dest) osip_message_header_get_byname((osip_message_t *) sip, (const char *) "encryption", pos, (osip_header_t **) dest)
#define osip_message_set_organization(sip, value) osip_message_set_header((osip_message_t *) sip, (const char *) "Organization", value)
#define osip_message_get_organization(sip, pos, dest) osip_message_header_get_byname((osip_message_t *) sip, (const char *) "organization", pos, (osip_header_t **) dest)
#define osip_message_set_require(sip, value) osip_message_set_header((osip_message_t *) sip, (const char *) "Require", value)
#define osip_message_get_require(sip, pos, dest) osip_message_header_get_byname((osip_message_t *) sip, (const char *) "require", pos, (osip_header_t **) dest)
#define osip_message_set_supported(sip, value) osip_message_set_header((osip_message_t *) sip, (const char *) "Supported", value)
#define osip_message_get_supported(sip, pos, dest) osip_message_header_get_byname((osip_message_t *) sip, (const char *) "supported", pos, (osip_header_t **) dest)
#define osip_message_set_timestamp(sip, value) osip_message_set_header((osip_message_t *) sip, (const char *) "Timestamp", value)
#define osip_message_get_timestamp(sip, pos, dest) osip_message_header_get_byname((osip_message_t *) sip, (const char *) "timestamp", pos, (osip_header_t **) dest)
#define osip_message_set_user_agent(sip, value) osip_message_set_header((osip_message_t *) sip, (const char *) "User-Agent", value)
#define osip_message_get_user_agent(sip, pos, dest) osip_message_header_get_byname((osip_message_t *) sip, (const char *) "user-agent", pos, (osip_header_t **) dest)
#define osip_message_set_content_language(sip, value) osip_message_set_header((osip_message_t *) sip, (const char *) "Content-Language", value)
#define osip_message_get_content_language(sip, pos, dest) osip_message_header_get_byname((osip_message_t *) sip, (const char *) "content-language", pos, (osip_header_t **) dest)
#define osip_message_set_expires(sip, value) osip_message_set_header((osip_message_t *) sip, (const char *) "Expires", value)
#define osip_message_get_expires(sip, pos, dest) osip_message_header_get_byname((osip_message_t *) sip, (const char *) "expires", pos, (osip_header_t **) dest)
#define osip_message_set_in_reply_to(sip, value) osip_message_set_header((osip_message_t *) sip, (const char *) "In-Reply-To", value)
#define osip_message_get_in_reply_to(sip, pos, dest) osip_message_header_get_byname((osip_message_t *) sip, (const char *) "in-reply-to", pos, (osip_header_t **) dest)
#define osip_message_set_max_forwards(sip, value) osip_message_set_header((osip_message_t *) sip, (const char *) "Max-Forwards", value)
#define osip_message_get_max_forwards(sip, pos, dest) osip_message_header_get_byname((osip_message_t *) sip, (const char *) "max-forwards", pos, (osip_header_t **) dest)
#define osip_message_set_priority(sip, value) osip_message_set_header((osip_message_t *) sip, (const char *) "Priority", value)
#define osip_message_get_priority(sip, pos, dest) osip_message_header_get_byname((osip_message_t *) sip, (const char *) "priority", pos, (osip_header_t **) dest)
#define osip_message_set_proxy_require(sip, value) osip_message_set_header((osip_message_t *) sip, (const char *) "Proxy-Require", value)
#define osip_message_get_proxy_require(sip, pos, dest) osip_message_header_get_byname((osip_message_t *) sip, (const char *) "proxy-require", pos, (osip_header_t **) dest)
#define osip_message_set_response_key(sip, value) osip_message_set_header((osip_message_t *) sip, (const char *) "Response-Key", value)
#define osip_message_get_response_key(sip, pos, dest) osip_message_header_get_byname((osip_message_t *) sip, (const char *) "response-key", pos, (osip_header_t **) dest)
#define osip_message_set_subject(sip, value) osip_message_set_header((osip_message_t *) sip, (const char *) "Subject", value)
#define osip_message_get_subject(sip, pos, dest) osip_message_header_get_byname((osip_message_t *) sip, (const char *) "subject", pos, (osip_header_t **) dest)
#define osip_message_set_retry_after(sip, value) osip_message_set_header((osip_message_t *) sip, (const char *) "Retry-After", value)
#define osip_message_get_retry_after(sip, pos, dest) osip_message_header_get_byname((osip_message_t *) sip, (const char *) "retry-after", pos, (osip_header_t **) dest)
#define osip_message_set_server(sip, value) osip_message_set_header((osip_message_t *) sip, (const char *) "Server", value)
#define osip_message_get_server(sip, pos, dest) osip_message_header_get_byname((osip_message_t *) sip, (const char *) "server", pos, (osip_header_t **) dest)
#define osip_message_set_unsupported(sip, value) osip_message_set_header((osip_message_t *) sip, (const char *) "Unsupported", value)
#define osip_message_get_unsupported(sip, pos, dest) osip_message_header_get_byname((osip_message_t *) sip, (const char *) "unsupported", pos, (osip_header_t **) dest)
#define osip_message_set_warning(sip, value) osip_message_set_header((osip_message_t *) sip, (const char *) "Warning", value)
#define osip_message_get_warning(sip, pos, dest) osip_message_header_get_byname((osip_message_t *) sip, (const char *) "warning", pos, (osip_header_t **) dest)
 
#ifdef __cplusplus
}
#endif
#endif