/usr/include/yuma/ncx/ses_msg.h is in libyuma-dev 2.10-1build1.
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 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 | /*
* Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
#ifndef _H_ses_msg
#define _H_ses_msg
/* FILE: ses_msg.h
*********************************************************************
* *
* P U R P O S E *
* *
*********************************************************************
NETCONF Session Message Common definitions module
*********************************************************************
* *
* C H A N G E H I S T O R Y *
* *
*********************************************************************
date init comment
----------------------------------------------------------------------
20-jan-07 abb Begun.
*/
#include <xmlstring.h>
#include <xmlreader.h>
#ifndef _H_dlq
#include "dlq.h"
#endif
#ifndef _H_ses
#include "ses.h"
#endif
#ifdef __cplusplus
extern "C" {
#endif
/********************************************************************
* *
* C O N S T A N T S *
* *
*********************************************************************/
/********************************************************************
* *
* T Y P E S *
* *
*********************************************************************/
/********************************************************************
* *
* F U N C T I O N S *
* *
*********************************************************************/
/********************************************************************
* FUNCTION ses_msg_init
*
* Initialize the session message manager module data structures
*
* INPUTS:
* none
* RETURNS:
* none
*********************************************************************/
extern void
ses_msg_init (void);
/********************************************************************
* FUNCTION ses_msg_cleanup
*
* Cleanup the session message manager module data structures
*
* INPUTS:
* none
* RETURNS:
* none
*********************************************************************/
extern void
ses_msg_cleanup (void);
/********************************************************************
* FUNCTION ses_msg_new_msg
*
* Malloc a new session message control header
*
* INPUTS:
* msg == address of ses_msg_t pointer that will be set
*
* OUTPUTS:
* *msg == malloced session message struct (if NO_ERR return)
*
* RETURNS:
* status
*********************************************************************/
extern status_t
ses_msg_new_msg (ses_msg_t **msg);
/********************************************************************
* FUNCTION ses_msg_free_msg
*
* Free the session message and all its buffer chunks
*
* INPUTS:
* scb == session control block owning the message
* msg == message to free (already removed from any Q)
*
*********************************************************************/
extern void
ses_msg_free_msg (ses_cb_t *scb,
ses_msg_t *msg);
/********************************************************************
* FUNCTION ses_msg_new_buff
*
* Malloc a new session buffer chuck
*
* Note that the buffer memory is not cleared after each use
* since this is not needed for byte stream IO
*
* INPUTS:
* scb == session control block to malloc a new message for
* outbuff == TRUE if this is for outgoing message
* FALSE if this is for incoming message
* buff == address of ses_msg_buff_t pointer that will be set
*
* OUTPUTS:
* *buff == malloced session buffer chunk (if NO_ERR return)
*
* RETURNS:
* status
*********************************************************************/
extern status_t
ses_msg_new_buff (ses_cb_t *scb,
boolean outbuff,
ses_msg_buff_t **buff);
/********************************************************************
* FUNCTION ses_msg_free_buff
*
* Free the session buffer chunk
*
* INPUTS:
* scb == session control block owning the message
* buff == buffer to free (already removed from any Q)
*
* RETURNS:
* none
*********************************************************************/
extern void
ses_msg_free_buff (ses_cb_t *scb,
ses_msg_buff_t *buff);
/********************************************************************
* FUNCTION ses_msg_write_buff
*
* Add some text to the message buffer
*
* INPUTS:
* scb == session control block to use
* buff == buffer to write to
* ch == xmlChar to write
*
* RETURNS:
* status_t
*
*********************************************************************/
extern status_t
ses_msg_write_buff (ses_cb_t *scb,
ses_msg_buff_t *buff,
uint32 ch);
/********************************************************************
* FUNCTION ses_msg_send_buffs
*
* Send multiple buffers to the session client socket
* Tries to send one packet at maximum MTU
*
* INPUTS:
* scb == session control block
*
* RETURNS:
* status
*********************************************************************/
extern status_t
ses_msg_send_buffs (ses_cb_t *scb);
/********************************************************************
* FUNCTION ses_msg_new_output_buff
*
* Put the current outbuff on the outQ
* Put the session on the outreadyQ if it is not already there
* Try to allocate a new buffer for the session
*
* INPUTS:
* scb == session control block
*
* OUTPUTS:
* scb->outbuff, scb->outready, and scb->outQ will be changed
*
* RETURNS:
* status, could return malloc or buffers exceeded error
*********************************************************************/
extern status_t
ses_msg_new_output_buff (ses_cb_t *scb);
/********************************************************************
* FUNCTION ses_msg_make_inready
*
* Put the session on the inreadyQ if it is not already there
*
* INPUTS:
* scb == session control block
*
* OUTPUTS:
* scb->inready will be queued on the inreadyQ
*********************************************************************/
extern void
ses_msg_make_inready (ses_cb_t *scb);
extern void
ses_msg_unmake_inready (ses_cb_t *scb);
/********************************************************************
* FUNCTION ses_msg_make_outready
*
* Put the session on the outreadyQ if it is not already there
*
* INPUTS:
* scb == session control block
*
* OUTPUTS:
* scb->outready will be queued on the outreadyQ
*********************************************************************/
extern void
ses_msg_make_outready (ses_cb_t *scb);
extern void
ses_msg_unmake_outready (ses_cb_t *scb);
/********************************************************************
* FUNCTION ses_msg_finish_outmsg
*
* Put the outbuff in the outQ if non-empty
* Put the session on the outreadyQ if it is not already there
*
* INPUTS:
* scb == session control block
*
* OUTPUTS:
* scb->outready will be queued on the outreadyQ
*********************************************************************/
extern void
ses_msg_finish_outmsg (ses_cb_t *scb);
/********************************************************************
* FUNCTION ses_msg_get_first_inready
*
* Dequeue the first entry in the inreadyQ, if any
*
* RETURNS:
* first entry in the inreadyQ or NULL if none
*********************************************************************/
extern ses_ready_t *
ses_msg_get_first_inready (void);
/********************************************************************
* FUNCTION ses_msg_get_first_outready
*
* Dequeue the first entry in the outreadyQ, if any
*
* RETURNS:
* first entry in the outreadyQ or NULL if none
*********************************************************************/
extern ses_ready_t *
ses_msg_get_first_outready (void);
/********************************************************************
* FUNCTION ses_msg_dump
*
* Dump the message contents
*
* INPUTS:
* msg == message to dump
* text == start text before message dump (may be NULL)
*
*********************************************************************/
extern void
ses_msg_dump (const ses_msg_t *msg,
const xmlChar *text);
/********************************************************************
* FUNCTION ses_msg_add_framing
*
* Add the base:1.1 framing chars to the buffer and adjust
* the buffer size pointers
*
* INPUTS:
* scb == session control block
* buff == buffer control block
*
* OUTPUTS:
* framing chars added to buff->buff
*
*********************************************************************/
extern void
ses_msg_add_framing (ses_cb_t *scb,
ses_msg_buff_t *buff);
/********************************************************************
* FUNCTION ses_msg_init_buff
*
* Init the buffer fields
*
* INPUTS:
* scb == session control block
* outbuff == TRUE if oupput buffer; FALSE if input buffer
* buff == buffer to send
*********************************************************************/
extern void
ses_msg_init_buff (ses_cb_t *scb,
boolean outbuff,
ses_msg_buff_t *buff);
#ifdef __cplusplus
} /* end extern 'C' */
#endif
#endif /* _H_ses_msg */
|