/usr/include/rampart-1.3.0/oxs_buffer.h is in librampart-dev 1.3.0-1ubuntu5.
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 | /*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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 OXS_BUFFER_H
#define OXS_BUFFER_H
/**
* @file oxs_buffer.h
* @brief The buffer representation in OMXMLSecurity.
*/
#include <axis2_defines.h>
#include <axutil_env.h>
#include <axis2_util.h>
#include <oxs_axiom.h>
#include <oxs_error.h>
#include <oxs_constants.h>
#include <stdio.h>
#ifdef __cplusplus
extern "C"
{
#endif
/** @defgroup oxs_buffer Buffer
* @ingroup oxs
* @{
*/
#define OXS_BUFFER_INITIAL_SIZE 1024
/**
* Allocate mode for the buffer
* oxs_alloc_mode_exact : Minimizes the allocated memory size
* oxs_alloc_mode_double : Minimizes number of Malloc calls
*/
typedef enum {
oxs_alloc_mode_exact = 0,
oxs_alloc_mode_double
} oxs_AllocMode;
/** Type name for struct oxs_buffer */
typedef struct oxs_buffer oxs_buffer_t;
/**
*Free function of the buffer
*@param buffer pointer to the OMXMLSec buffer struct
*@param env pointer to environment struct
*@return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
oxs_buffer_free(
oxs_buffer_t *buffer,
const axutil_env_t *env
);
/**
*Removes the first (size) charcters from the buffer
*@param buffer pointer to the OMXMLSec buffer struct
*@param env pointer to environment struct
*@param size number of characters to be removed
*@return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
oxs_buffer_remove_head(
oxs_buffer_t *buffer,
const axutil_env_t *env,
int size
);
/**
*Removes the last (size) charcters from the buffer
*@param buffer pointer to the OMXMLSec buffer struct
*@param env pointer to environment struct
*@param size number of characters to be removed
*@return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
oxs_buffer_remove_tail(
oxs_buffer_t *buffer,
const axutil_env_t *env,
int size
);
/**
*populates the buffer using the @data set the @size as the useful length
*@buffer pointer to the OMXMLSec buffer struct
*@env pointer to environment struct
*@data the data for the buffer
*@size the effective length of data
*@return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
oxs_buffer_populate(
oxs_buffer_t *buffer,
const axutil_env_t *env,
unsigned char *data,
int size
);
/**
*Append data (to the end)
*@buffer pointer to the OMXMLSec buffer struct
*@env pointer to environment struct
*@data the data for the buffer
*@size the effective length of data
*@return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
oxs_buffer_append(
oxs_buffer_t *buffer,
const axutil_env_t *env,
unsigned char *data,
int size
);
/**
*Prepends data (to the front of the buffer)
*@buffer pointer to the OMXMLSec buffer struct
*@env pointer to environment struct
*@data the data for the buffer
*@size the effective length of data
*@return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
oxs_buffer_prepend(
oxs_buffer_t *buffer,
const axutil_env_t *env,
unsigned char *data,
int size
);
/**
*Reads a file specified by @filename
*@buffer pointer to the OMXMLSec buffer struct
*@env pointer to environment struct
*@filename The name of the file
*@return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
oxs_buffer_read_file(
oxs_buffer_t *buffer,
const axutil_env_t *env,
const axis2_char_t *filename
);
/**
*Sets the size
*@buffer pointer to the OMXMLSec buffer struct
*@env pointer to environment struct
*@size the value of the size
*@return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
oxs_buffer_set_size(
oxs_buffer_t *buffer,
const axutil_env_t *env,
int size
);
/**
*Sets the maximum size of the buffer. Usually this will be allocated dynamically
*@buffer pointer to the OMXMLSec buffer struct
*@env pointer to environment struct
*@size the maximum size of the buffer
*@return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
oxs_buffer_set_max_size(
oxs_buffer_t *buffer,
const axutil_env_t *env,
int size
);
/**
*Returns data
*@buffer pointer to the OMXMLSec buffer struct
*@env pointer to environment struct
*@return data in the buffer
*/
AXIS2_EXTERN unsigned char* AXIS2_CALL
oxs_buffer_get_data(
oxs_buffer_t *buffer,
const axutil_env_t *env
);
/**
*Returns the effective length of the buffer
*@buffer pointer to the OMXMLSec buffer struct
*@env pointer to environment struct
*@return the effective length of the buffer as int
*/
AXIS2_EXTERN int AXIS2_CALL
oxs_buffer_get_size(
oxs_buffer_t *buffer,
const axutil_env_t *env
);
/**
*Returns the maximum size of the buffer
*@buffer pointer to the OMXMLSec buffer struct
*@env pointer to environment struct
*@return the maximum size of the buffer
*/
AXIS2_EXTERN int AXIS2_CALL
oxs_buffer_get_max_size(
oxs_buffer_t *buffer,
const axutil_env_t *env
);
AXIS2_EXTERN oxs_buffer_t *AXIS2_CALL
oxs_buffer_dup(oxs_buffer_t *buffer, const axutil_env_t *env);
AXIS2_EXTERN oxs_buffer_t *AXIS2_CALL
oxs_buffer_create(const axutil_env_t *env);
/** @} */
#ifdef __cplusplus
}
#endif
#endif /* OXS_BUFFER_H */
|