C API for BALTECH SDK
msgqueue.h
Go to the documentation of this file.
1 
51 #ifndef __BRP_BALTECH_API_CMDS_MSGQUEUE_H__
52 #define __BRP_BALTECH_API_CMDS_MSGQUEUE_H__
53 #include "../typedefs.h"
57 #define BRP_MsgQueue_ErrMsgqRecvTimeout BRP_ERR_STATUS(0xA600, 0x01)
58 
61 #define BRP_MsgQueue_ErrMsgqNotackedTimeout BRP_ERR_STATUS(0xA600, 0x02)
62 
65 #define BRP_MsgQueue_ErrMsgqCollision BRP_ERR_STATUS(0xA600, 0x03)
66 
69 #define BRP_MsgQueue_ErrMsgqBufoverflow BRP_ERR_STATUS(0xA600, 0x04)
70 
78 brp_errcode brp_MsgQueue_GetMsgSize(brp_protocol protocol, unsigned* BufferSize);
91 brp_errcode brp_MsgQueue_Receive(brp_protocol protocol, unsigned Timeout, brp_buf* RecvMsg, size_t* RecvMsg_len, brp_mempool *mempool);
105 brp_errcode brp_MsgQueue_Send(brp_protocol protocol, brp_buf SendMsg, size_t SendMsg_len, unsigned Timeout);
118 brp_errcode brp_MsgQueue_SendReceive(brp_protocol protocol, brp_buf SendMsg, size_t SendMsg_len, unsigned Timeout, brp_buf* RecvMsg, size_t* RecvMsg_len, brp_mempool *mempool);
119 #endif
120 
unsigned int brp_errcode
This type is used library-wide for passing error codes in the return value of functions.
Definition: errorcodes.h:23
struct brp_protocol_t * brp_protocol
This is a generic handle of a protocol.
Definition: protocol.h:34
struct brp_mempool_object_t * brp_mempool
mempool handle.
Definition: mempool.h:27
brp_errcode brp_MsgQueue_Receive(brp_protocol protocol, unsigned Timeout, brp_buf *RecvMsg, size_t *RecvMsg_len, brp_mempool *mempool)
Wait for a message and return its content.
brp_errcode brp_MsgQueue_GetMsgSize(brp_protocol protocol, unsigned *BufferSize)
Retrieve the maximum message size the reader supports.
brp_errcode brp_MsgQueue_Send(brp_protocol protocol, brp_buf SendMsg, size_t SendMsg_len, unsigned Timeout)
Put a message into the Message Queue and wait a maximum time of Timeout ms until the message has been...
unsigned char * brp_buf
represents a pointer to a protocol data buffer.
Definition: common.h:61
brp_errcode brp_MsgQueue_SendReceive(brp_protocol protocol, brp_buf SendMsg, size_t SendMsg_len, unsigned Timeout, brp_buf *RecvMsg, size_t *RecvMsg_len, brp_mempool *mempool)
This command combines Send and Receive to a single command.