/usr/include/openais/saMsg.h is in libsamsg4-dev 1.1.4-4.2.
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 | /*
* Copyright (c) 2005 MontaVista Software, Inc.
*
* All rights reserved.
*
* Author: Steven Dake (sdake@redhat.com)
*
* This software licensed under BSD license, the text of which follows:
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* - Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* - Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* - Neither the name of the MontaVista Software, Inc. nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef SAMSG_H_DEFINED
#define SAMSG_H_DEFINED
#ifdef __cplusplus
extern "C" {
#endif
typedef SaUint64T SaMsgHandleT;
typedef SaUint64T SaMsgQueueHandleT;
typedef SaUint64T SaMsgSenderIdT;
#define SA_MSG_MESSAGE_DELIVERED_ACK 0x1
typedef SaUint32T SaMsgAckFlagsT;
#define SA_MSG_QUEUE_PERSISTENT 0x1
typedef SaUint32T SaMsgQueueCreationFlagsT;
#define SA_MSG_MESSAGE_HIGHEST_PRIORITY 0
#define SA_MSG_MESSAGE_LOWEST_PRIORITY 3
typedef struct {
SaMsgQueueCreationFlagsT creationFlags;
SaSizeT size[SA_MSG_MESSAGE_LOWEST_PRIORITY + 1];
SaTimeT retentionTime;
} SaMsgQueueCreationAttributesT;
#define SA_MSG_QUEUE_CREATE 0x1
#define SA_MSG_QUEUE_RECEIVE_CALLBACK 0x2
#define SA_MSG_QUEUE_EMPTY 0x4
typedef SaUint32T SaMsgQueueOpenFlagsT;
typedef struct {
SaSizeT queueSize;
SaSizeT queueUsed;
SaUint32T numberOfMessages;
} SaMsgQueueUsageT;
typedef struct {
SaMsgQueueCreationFlagsT creationFlags;
SaTimeT retentionTime;
SaTimeT closeTime;
SaMsgQueueUsageT saMsgQueueUsage[SA_MSG_MESSAGE_LOWEST_PRIORITY + 1];
} SaMsgQueueStatusT;
typedef enum {
SA_MSG_QUEUE_GROUP_ROUND_ROBIN = 1,
SA_MSG_QUEUE_GROUP_LOCAL_ROUND_ROBIN = 2,
SA_MSG_QUEUE_GROUP_LOCAL_BEST_QUEUE = 3,
SA_MSG_QUEUE_GROUP_BROADCAST = 4
} SaMsgQueueGroupPolicyT;
typedef enum {
SA_MSG_QUEUE_GROUP_NO_CHANGE = 1,
SA_MSG_QUEUE_GROUP_ADDED = 2,
SA_MSG_QUEUE_GROUP_REMOVED = 3,
SA_MSG_QUEUE_GROUP_STATE_CHANGED = 4
} SaMsgQueueGroupChangesT;
typedef struct {
SaNameT queueName;
} SaMsgQueueGroupMemberT;
typedef struct {
SaMsgQueueGroupMemberT member;
SaMsgQueueGroupChangesT change;
} SaMsgQueueGroupNotificationT;
typedef struct {
SaUint32T numberOfItems;
SaMsgQueueGroupNotificationT *notification;
SaMsgQueueGroupPolicyT queueGroupPolicy;
} SaMsgQueueGroupNotificationBufferT;
typedef struct {
SaUint32T type;
SaUint32T version;
SaSizeT size;
SaNameT *senderName;
void *data;
SaUint8T priority;
} SaMsgMessageT;
typedef void (*SaMsgQueueOpenCallbackT) (
SaInvocationT invocation,
SaMsgQueueHandleT queueHandle,
SaAisErrorT error);
typedef void (*SaMsgQueueGroupTrackCallbackT) (
const SaNameT *queueGroupName,
const SaMsgQueueGroupNotificationBufferT *notificationBuffer,
SaUint32T numberOfMembers,
SaAisErrorT error);
typedef void (*SaMsgMessageDeliveredCallbackT) (
SaInvocationT invocation,
SaAisErrorT error);
typedef void (*SaMsgMessageReceivedCallbackT) (
SaMsgQueueHandleT queueHandle);
typedef struct {
SaMsgQueueOpenCallbackT saMsgQueueOpenCallback;
SaMsgQueueGroupTrackCallbackT saMsgQueueGroupTrackCallback;
SaMsgMessageDeliveredCallbackT saMsgMessageDeliveredCallback;
SaMsgMessageReceivedCallbackT saMsgMessageReceivedCallback;
} SaMsgCallbacksT;
typedef enum {
SA_MSG_QUEUE_CAPACITY_REACHED = 1,
SA_MSG_QUEUE_CAPACITY_AVAILABLE = 2,
SA_MSG_QUEUE_GROUP_CAPACITY_REACHED = 3,
SA_MSG_QUEUE_GROUP_CAPACITY_AVAILABLE = 4
} SaMsgMessageCapacityStatusT;
typedef struct {
SaSizeT capacityReached[SA_MSG_MESSAGE_LOWEST_PRIORITY + 1];
SaSizeT capacityAvailable[SA_MSG_MESSAGE_LOWEST_PRIORITY + 1];
} SaMsgQueueThresholdsT;
typedef enum {
SA_MSG_DEST_CAPACITY_STATUS = 1
} SaMsgStateT;
typedef enum {
SA_MSG_MAX_PRIORITY_AREA_SIZE_ID = 1,
SA_MSG_MAX_QUEUE_SIZE_ID = 2,
SA_MSG_MAX_NUM_QUEUES_ID = 3,
SA_MSG_MAX_NUM_QUEUE_GROUPS_ID = 4,
SA_MSG_MAX_NUM_QUEUES_PER_GROUP_ID = 5,
SA_MSG_MAX_MESSAGE_SIZE_ID = 6,
SA_MSG_MAX_REPLY_SIZE_ID = 7
} SaMsgLimitIdT;
SaAisErrorT
saMsgInitialize (
SaMsgHandleT *msgHandle,
const SaMsgCallbacksT *msgCallbacks,
SaVersionT *version);
SaAisErrorT
saMsgSelectionObjectGet (
SaMsgHandleT msgHandle,
SaSelectionObjectT *selectionObject);
SaAisErrorT
saMsgDispatch (
SaMsgHandleT msgHandle,
SaDispatchFlagsT dispatchFlags);
SaAisErrorT
saMsgFinalize (
SaMsgHandleT msgHandle);
SaAisErrorT
saMsgQueueOpen (
SaMsgHandleT msgHandle,
const SaNameT *queueName,
const SaMsgQueueCreationAttributesT *creationAttributes,
SaMsgQueueOpenFlagsT openFlags,
SaTimeT timeout,
SaMsgQueueHandleT *queueHandle);
SaAisErrorT
saMsgQueueOpenAsync (
SaMsgHandleT msgHandle,
SaInvocationT invocation,
const SaNameT *queueName,
const SaMsgQueueCreationAttributesT *creationAttributes,
SaMsgQueueOpenFlagsT openFlags);
SaAisErrorT
saMsgQueueClose (
SaMsgQueueHandleT queueHandle);
SaAisErrorT
saMsgQueueStatusGet (
SaMsgHandleT msgHandle,
const SaNameT *queueName,
SaMsgQueueStatusT *queueStatus);
SaAisErrorT
saMsgQueueRetentionTimeSet (
SaMsgQueueHandleT queueHandle,
SaTimeT *retentionTime);
SaAisErrorT
saMsgQueueUnlink (
SaMsgHandleT msgHandle,
const SaNameT *queueName);
SaAisErrorT
saMsgQueueGroupCreate (
SaMsgHandleT msgHandle,
const SaNameT *queueGroupName,
SaMsgQueueGroupPolicyT queueGroupPolicy);
SaAisErrorT
saMsgQueueGroupInsert (
SaMsgHandleT msgHandle,
const SaNameT *queueGroupName,
const SaNameT *queueName);
SaAisErrorT
saMsgQueueGroupRemove (
SaMsgHandleT msgHandle,
const SaNameT *queueGroupName,
const SaNameT *queueName);
SaAisErrorT
saMsgQueueGroupDelete (
SaMsgHandleT msgHandle,
const SaNameT *queueGroupName);
SaAisErrorT
saMsgQueueGroupTrack (
SaMsgHandleT msgHandle,
const SaNameT *queueGroupName,
SaUint8T trackFlags,
SaMsgQueueGroupNotificationBufferT *notificationBuffer);
SaAisErrorT
saMsgQueueGroupTrackStop (
SaMsgHandleT msgHandle,
const SaNameT *queueGroupName);
SaAisErrorT
saMsgQueueGroupNotificationFree (
SaMsgHandleT msgHandle,
SaMsgQueueGroupNotificationT *notification);
SaAisErrorT
saMsgMessageSend (
SaMsgHandleT msgHandle,
const SaNameT *destination,
const SaMsgMessageT *message,
SaTimeT timeout);
SaAisErrorT
saMsgMessageSendAsync (
SaMsgHandleT msgHandle,
SaInvocationT invocation,
const SaNameT *destination,
const SaMsgMessageT *message,
SaMsgAckFlagsT ackFlags);
SaAisErrorT
saMsgMessageGet (
SaMsgQueueHandleT queueHandle,
SaMsgMessageT *message,
SaTimeT *sendTime,
SaMsgSenderIdT *senderId,
SaTimeT timeout);
SaAisErrorT
saMsgMessageDataFree (
SaMsgHandleT msgHandle,
void *data);
SaAisErrorT
saMsgMessageCancel (
SaMsgQueueHandleT queueHandle);
SaAisErrorT
saMsgMessageSendReceive (
SaMsgHandleT msgHandle,
const SaNameT *destination,
const SaMsgMessageT *sendMessage,
SaMsgMessageT *receiveMessage,
SaTimeT *replySendTime,
SaTimeT timeout);
SaAisErrorT
saMsgMessageReply (
SaMsgHandleT msgHandle,
const SaMsgMessageT *replyMessage,
const SaMsgSenderIdT *senderId,
SaTimeT timeout);
SaAisErrorT
saMsgMessageReplyAsync (
SaMsgHandleT msgHandle,
SaInvocationT invocation,
const SaMsgMessageT *replyMessage,
const SaMsgSenderIdT *senderId,
SaMsgAckFlagsT ackFlags);
SaAisErrorT
saMsgQueueCapacityThresholdsSet (
SaMsgQueueHandleT queueHandle,
const SaMsgQueueThresholdsT *thresholds);
SaAisErrorT
saMsgQueueCapacityThresholdsGet (
SaMsgQueueHandleT queueHandle,
SaMsgQueueThresholdsT *thresholds);
SaAisErrorT
saMsgMetadataSizeGet (
SaMsgHandleT msgHandle,
SaUint32T *metadataSize);
SaAisErrorT
saMsgLimitGet (
SaMsgHandleT msgHandle,
SaMsgLimitIdT limitId,
SaLimitValueT *limitValue);
#endif /* SAMSG_H_DEFINED */
|