/usr/include/pjsip/sip_multipart.h is in libpjproject-dev 2.7.2~dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 | /* $Id: sip_multipart.h 5569 2017-03-21 07:19:43Z nanang $ */
/*
* Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com)
*
* This program 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.
*
* This program 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
*/
#ifndef __PJSIP_SIP_MULTIPART_H__
#define __PJSIP_SIP_MULTIPART_H__
/**
* @file pjsip/sip_multipart.h
* @brief Multipart support.
*/
#include <pjsip/sip_msg.h>
PJ_BEGIN_DECL
/**
* @defgroup PJSIP_MULTIPART Multipart message bodies.
* @ingroup PJSIP_MSG
* @brief Support for multipart message bodies.
* @{
*/
/**
* This structure describes the individual body part inside a multipart
* message body. It mainly contains the message body itself and optional
* headers.
*/
typedef struct pjsip_multipart_part
{
/**
* Standard list element.
*/
PJ_DECL_LIST_MEMBER(struct pjsip_multipart_part);
/**
* Optional message headers.
*/
pjsip_hdr hdr;
/**
* Pointer to the message body.
*/
pjsip_msg_body *body;
} pjsip_multipart_part;
/**
* Create an empty multipart body.
*
* @param pool Memory pool to allocate memory from.
* @param ctype Optional MIME media type of the multipart
* bodies. If not specified, "multipart/mixed"
* will be used.
* @param boundary Optional string to be set as part boundary.
* The boundary string excludes the leading
* hyphens. If this parameter is NULL or empty,
* a random boundary will be generated.
*
* @return Multipart body instance with no part.
*/
PJ_DECL(pjsip_msg_body*) pjsip_multipart_create(pj_pool_t *pool,
const pjsip_media_type *ctype,
const pj_str_t *boundary);
/**
* Create an empty multipart part.
*
* @param pool The memory pool.
*
* @return The multipart part.
*/
PJ_DECL(pjsip_multipart_part*) pjsip_multipart_create_part(pj_pool_t *pool);
/**
* Perform a deep clone to a multipart part.
*
* @param pool The memory pool.
* @param part The part to be duplicated.
*
* @return Copy of the multipart part.
*/
PJ_DECL(pjsip_multipart_part*)
pjsip_multipart_clone_part(pj_pool_t *pool,
const pjsip_multipart_part *part);
/**
* Add a part into multipart bodies.
*
* @param pool The memory pool.
* @param mp The multipart bodies.
* @param part The part to be added into the bodies.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjsip_multipart_add_part(pj_pool_t *pool,
pjsip_msg_body *mp,
pjsip_multipart_part *part);
/**
* Get the first part of multipart bodies.
*
* @param mp The multipart bodies.
*
* @return The first part, or NULL if the multipart
* bodies currently doesn't hold any elements.
*/
PJ_DECL(pjsip_multipart_part*)
pjsip_multipart_get_first_part(const pjsip_msg_body *mp);
/**
* Get the next part after the specified part.
*
* @param mp The multipart bodies.
* @param part The part.
*
* @return The next part, or NULL if there is no other part after
* the part.
*/
PJ_DECL(pjsip_multipart_part*)
pjsip_multipart_get_next_part(const pjsip_msg_body *mp,
pjsip_multipart_part *part);
/**
* Find a body inside multipart bodies which has the specified content type.
*
* @param mp The multipart body.
* @param content_type Content type to find.
* @param start If specified, the search will begin at
* start->next. Otherwise it will begin at
* the first part in the multipart bodies.
*
* @return The first part with the specified content type
* if found, or NULL.
*/
PJ_DECL(pjsip_multipart_part*)
pjsip_multipart_find_part( const pjsip_msg_body *mp,
const pjsip_media_type *content_type,
const pjsip_multipart_part *start);
/**
* Parse multipart message.
*
* @param pool Memory pool.
* @param buf Input buffer.
* @param len The buffer length.
* @param ctype Content type of the multipart body.
* @param options Parsing options, must be zero for now.
*
* @return Multipart message body.
*/
PJ_DECL(pjsip_msg_body*) pjsip_multipart_parse(pj_pool_t *pool,
char *buf, pj_size_t len,
const pjsip_media_type *ctype,
unsigned options);
/**
* Get the boundary string and the raw message body of the specified
* multipart message body. Note that raw message body will only be available
* if the multipart message body is generated by pjsip_multipart_parse().
*
* @param mp The multipart message body.
* @param boundary Optional parameter to receive the boundary string.
* @param raw_data Optional parameter to receive the raw message body.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjsip_multipart_get_raw(pjsip_msg_body *mp,
pj_str_t *boundary,
pj_str_t *raw_data);
/**
* @} PJSIP_MULTIPART
*/
PJ_END_DECL
#endif /* __PJSIP_SIP_MULTIPART_H__ */
|