UM C API  6.12.1
lbm_msg_t_stct Struct Reference

Structure that stores information about a received message. It is delivered to the application via the receiver callback function (lbm_rcv_cb_proc). More...

#include <lbm.h>

Data Fields

char source [LBM_MSG_MAX_SOURCE_LEN]
 
char topic_name [LBM_MSG_MAX_TOPIC_LEN]
 
char copied_state [LBM_MSG_MAX_STATE_LEN]
 
int type
 
int flags
 
const char * data
 
size_t len
 
lbm_response_tresponse
 
lbm_uint_t sequence_number
 
long refcnt
 
size_t apphdr_len
 
lbm_ulong_t apphdr_code
 
lbm_timeval_t tsp
 
lbm_ushort_t hdrlen
 
const lbm_buff_t * buffer
 
const void * fragment_info
 
const char * apphdr_data
 
const void * source_clientd
 
const void * umeack
 
const void * src_cd
 
lbm_uint_t osqn
 
lbm_msg_channel_info_tchannel_info
 
const void * umq_msgid
 
const void * umq_cr
 
const void * pdata
 
size_t plen
 
lbm_msg_properties_tproperties
 
lbm_hf_sequence_number_t hf_sequence_number
 
const void * broker_msg_state
 
lbm_timespec_t hr_timestamp
 

Detailed Description

Structure that stores information about a received message. It is delivered to the application via the receiver callback function (lbm_rcv_cb_proc).

See also
lbm_rcv_create

Field Documentation

lbm_ulong_t lbm_msg_t_stct::apphdr_code

UM internal only. DO NOT ACCESS DIRECTLY!

const char* lbm_msg_t_stct::apphdr_data

UM internal only. DO NOT ACCESS DIRECTLY! To access information about application headers, see lbm_apphdr_chain_iter_create_from_msg().

size_t lbm_msg_t_stct::apphdr_len

UM internal only. DO NOT ACCESS DIRECTLY!

const void* lbm_msg_t_stct::broker_msg_state

UM internal only. DO NOT ACCESS DIRECTLY!

const lbm_buff_t* lbm_msg_t_stct::buffer

UM internal only. DO NOT ACCESS DIRECTLY!

lbm_msg_channel_info_t* lbm_msg_t_stct::channel_info

Channel information set when using Spectrum channels

char lbm_msg_t_stct::copied_state[LBM_MSG_MAX_STATE_LEN]

Copy of the state of the msg (only used on specific platforms. DO NOT ACCESS DIRECTLY!)

const char* lbm_msg_t_stct::data

Data contents of the message if of a message type that carries data. Note that UM does not guarantee any alignment of that data.

int lbm_msg_t_stct::flags

Bitmap indicating extra information about the message. Zero or more flag bits ORed together LBM_MSG_FLAG_*, not including LBM_MSG_FLAG_NUMBERED_CHANNEL.

const void* lbm_msg_t_stct::fragment_info

UM internal only. DO NOT ACCESS DIRECTLY! To access information about message fragments, see lbm_msg_retrieve_fragment_info().

lbm_ushort_t lbm_msg_t_stct::hdrlen

UM internal only. DO NOT ACCESS DIRECTLY!

lbm_hf_sequence_number_t lbm_msg_t_stct::hf_sequence_number

Hot failover sequence number, check message flags for LBM_MSG_FLAG_HF_32 or LBM_MSG_FLAG_HF_64.

lbm_timespec_t lbm_msg_t_stct::hr_timestamp

High Resolution Timestamp of the received message

size_t lbm_msg_t_stct::len

Length of data in bytes

lbm_uint_t lbm_msg_t_stct::osqn

UM internal only. DO NOT ACCESS DIRECTLY!

const void* lbm_msg_t_stct::pdata

UM internal only. DO NOT ACCESS DIRECTLY!

size_t lbm_msg_t_stct::plen

UM internal only. DO NOT ACCESS DIRECTLY!

lbm_msg_properties_t* lbm_msg_t_stct::properties

Message properties structure for this message. See lbm_msg_properties_get() and lbm_msg_properties_iter_first().

long lbm_msg_t_stct::refcnt

UM internal only. DO NOT ACCESS DIRECTLY!

lbm_response_t* lbm_msg_t_stct::response

Pointer to response object used for sending responses for lbm_msg_t request.

lbm_uint_t lbm_msg_t_stct::sequence_number

Topic level sequence number of message. For fragmented messages, this is the sequence number of the final fragment comprising the message.

char lbm_msg_t_stct::source[LBM_MSG_MAX_SOURCE_LEN]

Source string of transport session. See Source String.

const void* lbm_msg_t_stct::source_clientd

The per-source clientd value for the source set by the lbm_rcv_src_notification_create_function_cb callback

const void* lbm_msg_t_stct::src_cd

UM internal only. DO NOT ACCESS DIRECTLY!

char lbm_msg_t_stct::topic_name[LBM_MSG_MAX_TOPIC_LEN]

Name of the topic. Although this field is allocated at 256 bytes, legal topic names are restricted to 246 bytes.

lbm_timeval_t lbm_msg_t_stct::tsp

Timestamp indicating the earliest time that the message was received, in seconds and microseconds since midnight, January 1st, 1970 UTC. This time can be up to 500 milliseconds prior to actual receipt time, and hence, is not suitable when accurate message-arrival-time measurements are needed.

int lbm_msg_t_stct::type

Type of message.

const void* lbm_msg_t_stct::umeack

UM internal only. DO NOT ACCESS DIRECTLY!

const void* lbm_msg_t_stct::umq_cr

UM internal only. DO NOT ACCESS DIRECTLY!

const void* lbm_msg_t_stct::umq_msgid

UM internal only. DO NOT ACCESS DIRECTLY!


The documentation for this struct was generated from the following file: