parse_via.h

Go to the documentation of this file.

/*
 * $Id: parse_via.h 4720 2008-08-23 10:56:15Z henningw $
 *
 * Copyright (C) 2001-2003 FhG Fokus
 *
 * This file is part of Kamailio, a free SIP server.
 *
 * Kamailio is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version
 *
 * Kamailio 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License 
 * along with this program; if not, write to the Free Software 
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

/*
 *  2003-01-21  added rport parsing code, contributed by
 *               Maxim Sobolev  <sobomax@FreeBSD.org>
 *  2003-01-21  added extra via param parsing code (i=...), used
 *               by tcp to identify the sending socket, by andrei
 *  2003-01-27  added a new member (start) to via_param, by andrei
 *  2003-10-27  added alias to via && PARAM_ALIAS (andrei)
 */

/*!
 * \file
 * \brief VIA parsing automaton
 * \ingroup parser
 */


#ifndef PARSE_VIA_H
#define PARSE_VIA_H

#include "../str.h"

/*! via param types
 * \warning WARNING: keep in sync with parse_via.c FIN_HIDDEN and with tm/sip_msg.c via_body_cloner
 */
enum {
   PARAM_HIDDEN=230, PARAM_TTL, PARAM_BRANCH, 
   PARAM_MADDR, PARAM_RECEIVED, PARAM_RPORT, PARAM_I, PARAM_ALIAS,
   GEN_PARAM,
   PARAM_ERROR
};



struct via_param {
   int type;               /* Type of the parameter */
   str name;               /* Name of the parameter */
   str value;              /* Value of the parameter */
   char* start;            /* Pointer to param start, just after ';',
                      * (it can be diff. from name.s!) */
   int size;               /* total size, including preceding and trailing
                      * white space */
   struct via_param* next; /* Next parameter in the list */
};


/*! Format: name/version/transport host:port;params comment
 * \warning keep in sync with tm/sip_msg.c via_body_cloner */
struct via_body { 
   int error;
   str hdr;   /*!< Contains "Via" or "v" */
   str name;
   str version;
   str transport;
   str host;
   unsigned short proto; /*!< transport */
   unsigned short port;
   str port_str;
   str params;
   str comment;
   unsigned int bsize;           /*!< body size, not including hdr */
   struct via_param* param_lst;  /*!< list of parameters*/
   struct via_param* last_param; /*!< last via parameter, internal use*/

   /* shortcuts to "important" params*/
   struct via_param* branch;
   str tid; /*!< transaction id, part of branch */
   struct via_param* received;
   struct via_param* rport;
   struct via_param* i;
   struct via_param* alias; /*!< alias see draft-ietf-sip-connect-reuse-00 */
   struct via_param* maddr;
   struct via_body* next; /*!< pointer to next via body string if
              compact via or null */
};


/*!
 * Main Via header field parser
 */
char* parse_via(char* buffer, char* end, struct via_body *vb);


/*!
 * Free allocated memory
 */
void free_via_list(struct via_body *vb);


#endif /* PARSE_VIA_H */