doubango-android/tinySIP/include/tinysip/headers/tsip_header_Referred_By.h

/*
* Copyright (C) 2010-2011 Mamadou Diop.
*
* Contact: Mamadou Diop <diopmamadou(at)doubango[dot]org>
*
* This file is part of Open Source Doubango Framework.
*
* DOUBANGO 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 3 of the License, or
* (at your option) any later version.
*
* DOUBANGO 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 DOUBANGO.
*
*/

/**@file tsip_header_Referred_By.h
 * @brief SIP Referred-By header as per RFC 3892.
 *
 * @author Mamadou Diop <diopmamadou(at)doubango[dot]org>
 *

 */
#ifndef _TSIP_HEADER_REFERRED_BY_H_
#define _TSIP_HEADER_REFERRED_BY_H_

#include "tinysip_config.h"

#include "tinysip/tsip_uri.h"
#include "tinysip/headers/tsip_header.h"

TSIP_BEGIN_DECLS

#define TSIP_HEADER_REFERRED_BY_VA_ARGS(uri, cid)	tsip_header_Referred_By_def_t, (const tsip_uri_t*)uri, (const char*)cid

////////////////////////////////////////////////////////////////////////////////////////////////////
///
/// @brief	SIP header 'Referred-By'.
///
/// @par ABNF: Referred-By	= 	( "Referred-By" / "b" ) HCOLON referrer-uri *( SEMI (referredby-id-param / generic-param) )
///
////////////////////////////////////////////////////////////////////////////////////////////////////
typedef struct tsip_header_Referred_By_s {
    TSIP_DECLARE_HEADER;

    char *display_name;
    tsip_uri_t *uri;

    char* cid;
}
tsip_header_Referred_By_t;

TINYSIP_API tsip_header_Referred_By_t* tsip_header_Referred_By_create(const tsip_uri_t* uri, const char* cid);
TINYSIP_API tsip_header_Referred_By_t* tsip_header_Referred_By_create_null();

TINYSIP_API tsip_header_Referred_By_t *tsip_header_Referred_By_parse(const char *data, tsk_size_t size);

TINYSIP_GEXTERN const tsk_object_def_t *tsip_header_Referred_By_def_t;

TSIP_END_DECLS

#endif /* _TSIP_HEADER_REFERRED_BY_H_ */