posix_msg_que.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: LicenseRef-NvidiaProprietary
 *
 * NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
 * property and proprietary rights in and to this material, related
 * documentation and any modifications thereto. Any use, reproduction,
 * disclosure or distribution of this material and related documentation
 * without an express license agreement from NVIDIA CORPORATION or
 * its affiliates is strictly prohibited.
*/
#ifndef POSIX_MSG_QUEUE_H
#define POSIX_MSG_QUEUE_H
 
#include <mqueue.h>
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define MQ_PERMISSIONS 0660
 
#define MQ_MAX_MESSAGES 10
 
#define MQ_MAX_MSG_SIZE 2048
 
#define MQ_MSG_BUFFER_SIZE (MQ_MAX_MSG_SIZE + 32)
 
#define MSG_PRIO_DEFAULT 10
 
typedef enum NvPSFMsgQueEndpointType_t {
    MSG_QUE_RECEIVER = 0, 
    MSG_QUE_SENDER,        
    MSG_QUE_BIDIRECTIONAL
} NvPSFMsgQueEndpointType;
 
typedef enum NvPSFMsgQueBlockingMode_t {
    BLOCKING = 0, 
    NON_BLOCKING  
} NvPSFMsgQueBlockingMode;
 
typedef enum NvPSFMsgQueErr_t {
    NvPSFMSGQ_SUCCESS = 0, 
    NvPSFMSGQ_FAIL = 1     
} NvPSFMsgQueErr;
 
typedef union NvPSFMsgQueRetCode_t {
    int mqd;        
    int errCode;   
    int recvd_bytes; 
} NvPSFMsgQueRetCode;
 
typedef struct NvPSFMsgQueStatus_t {
    NvPSFMsgQueErr err;      
    NvPSFMsgQueRetCode retCode; 
} NvPSFMsgQueStatus;
 
NvPSFMsgQueStatus NvPSFMsgQueCreate(const char* name, const NvPSFMsgQueEndpointType endpointType,
                             const NvPSFMsgQueBlockingMode blockingMode);
 
NvPSFMsgQueStatus NvPSFMsgQueClose(mqd_t mqdes);
 
NvPSFMsgQueStatus NvPSFMsgQueUnlink(const char* name);
 
NvPSFMsgQueStatus NvPSFMsgQueSend(mqd_t mqdes, const char* msg, size_t msgLen, unsigned int priority);
 
NvPSFMsgQueStatus NvPSFMsgQueReceive(mqd_t mqdes, char* buffer, size_t bufferLen, unsigned int* priority);
 
#ifdef __cplusplus
}
#endif
 
#endif // POSIX_MSG_QUEUE_H