parse_nameaddr.h

Go to the documentation of this file.
00001 /*
00002  * $Id: parse_nameaddr.h 4720 2008-08-23 10:56:15Z henningw $
00003  *
00004  * Copyright (C) 2001-2003 FhG Fokus
00005  *
00006  * This file is part of Kamailio, a free SIP server.
00007  *
00008  * Kamailio is free software; you can redistribute it and/or modify
00009  * it under the terms of the GNU General Public License as published by
00010  * the Free Software Foundation; either version 2 of the License, or
00011  * (at your option) any later version
00012  *
00013  * Kamailio is distributed in the hope that it will be useful,
00014  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00015  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00016  * GNU General Public License for more details.
00017  *
00018  * You should have received a copy of the GNU General Public License 
00019  * along with this program; if not, write to the Free Software 
00020  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00021  */
00022 
00023 /*!
00024  * \file
00025  * \brief Name-addr part parser
00026  * \ingroup parser
00027  */
00028 
00029 #ifndef PARSE_NAMEADDR_H
00030 #define PARSE_NAMEADDR_H
00031 
00032 #include <stdio.h>
00033 #include "../str.h"
00034 
00035 /*!
00036  * Name-addr structure, see RFC3261 for more details
00037  */
00038 typedef struct name_addr {
00039    str name;   /*!< Display name part */
00040    str uri;    /*!< Uri part without surrounding <> */
00041    int len;    /*!< Total length of the field (including all
00042          whitechars present in the parsed message */
00043 } name_addr_t;
00044 
00045 
00046 /*!
00047  * Parse name-addr part, the given string can be longer,
00048  * parsing will stop when closing
00049  * \return zero on success (if found), negative value on error
00050  */
00051 int parse_nameaddr(str* _s, name_addr_t* _a);
00052 
00053 
00054 /*!
00055  * Print a name-addr structure, just for debugging
00056  */
00057 void print_nameaddr(FILE* _o, name_addr_t* _a);
00058 
00059 
00060 #endif /* PARSE_NAMEADDR_H */