Classes | Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
zmq::msg_t Class Reference

#include <msg.hpp>

Classes

struct  content_t
 
union  group_t
 
struct  long_group_t
 

Public Types

enum  {
  more = 1, command = 2, ping = 4, pong = 8,
  subscribe = 12, cancel = 16, close_cmd = 20, credential = 32,
  routing_id = 64, shared = 128
}
 
enum  { msg_t_size = 64 }
 
enum  { max_vsm_size }
 
enum  { ping_cmd_name_size = 5, cancel_cmd_name_size = 7, sub_cmd_name_size = 10 }
 

Public Member Functions

void add_refs (int refs_)
 
bool check () const
 
int close ()
 
void * command_body ()
 
size_t command_body_size () const
 
int copy (msg_t &src_)
 
void * data ()
 
unsigned char flags () const
 
uint32_t get_routing_id () const
 
const char * group () const
 
int init ()
 
int init (void *data_, size_t size_, msg_free_fn *ffn_, void *hint_, content_t *content_=NULL)
 
int init_buffer (const void *buf_, size_t size_)
 
int init_cancel (const size_t size_, const unsigned char *topic)
 
int init_data (void *data_, size_t size_, msg_free_fn *ffn_, void *hint_)
 
int init_delimiter ()
 
int init_external_storage (content_t *content_, void *data_, size_t size_, msg_free_fn *ffn_, void *hint_)
 
int init_join ()
 
int init_leave ()
 
int init_size (size_t size_)
 
int init_subscribe (const size_t size_, const unsigned char *topic)
 
bool is_cancel () const
 
bool is_close_cmd () const
 
bool is_cmsg () const
 
bool is_credential () const
 
bool is_delimiter () const
 
bool is_join () const
 
bool is_leave () const
 
bool is_lmsg () const
 
bool is_ping () const
 
bool is_pong () const
 
bool is_routing_id () const
 
bool is_subscribe () const
 
bool is_vsm () const
 
bool is_zcmsg () const
 
metadata_t * metadata () const
 
int move (msg_t &src_)
 
void reset_flags (unsigned char flags_)
 
void reset_metadata ()
 
int reset_routing_id ()
 
bool rm_refs (int refs_)
 
void set_flags (unsigned char flags_)
 
int set_group (const char *, size_t length_)
 
int set_group (const char *group_)
 
void set_metadata (metadata_t *metadata_)
 
int set_routing_id (uint32_t routing_id_)
 
void shrink (size_t new_size_)
 
size_t size () const
 

Private Types

enum  group_type_t { group_type_short, group_type_long }
 
enum  type_t {
  type_min = 101, type_vsm = 101, type_lmsg = 102, type_delimiter = 103,
  type_cmsg = 104, type_zclmsg = 105, type_join = 106, type_leave = 107,
  type_max = 107
}
 

Private Member Functions

zmq::atomic_counter_t * refcnt ()
 

Private Attributes

union {
   struct {
      unsigned char   flags
 
      group_t   group
 
      metadata_t *   metadata
 
      uint32_t   routing_id
 
      unsigned char   type
 
      unsigned char   unused [msg_t_size -(sizeof(metadata_t
         *)+2+sizeof(uint32_t)+sizeof(group_t))]
 
   }   base
 
   struct {
      void *   data
 
      unsigned char   flags
 
      group_t   group
 
      metadata_t *   metadata
 
      uint32_t   routing_id
 
      size_t   size
 
      unsigned char   type
 
      unsigned char   unused [msg_t_size -(sizeof(metadata_t
         *)+sizeof(void *)+sizeof(size_t)+2+sizeof(uint32_t)+sizeof(group_t))]
 
   }   cmsg
 
   struct {
      unsigned char   flags
 
      group_t   group
 
      metadata_t *   metadata
 
      uint32_t   routing_id
 
      unsigned char   type
 
      unsigned char   unused [msg_t_size -(sizeof(metadata_t
         *)+2+sizeof(uint32_t)+sizeof(group_t))]
 
   }   delimiter
 
   struct {
      content_t *   content
 
      unsigned char   flags
 
      group_t   group
 
      metadata_t *   metadata
 
      uint32_t   routing_id
 
      unsigned char   type
 
      unsigned char   unused [msg_t_size -(sizeof(metadata_t
         *)+sizeof(content_t
         *)+2+sizeof(uint32_t)+sizeof(group_t))]
 
   }   lmsg
 
   struct {
      unsigned char   data [max_vsm_size]
 
      unsigned char   flags
 
      group_t   group
 
      metadata_t *   metadata
 
      uint32_t   routing_id
 
      unsigned char   size
 
      unsigned char   type
 
   }   vsm
 
   struct {
      content_t *   content
 
      unsigned char   flags
 
      group_t   group
 
      metadata_t *   metadata
 
      uint32_t   routing_id
 
      unsigned char   type
 
      unsigned char   unused [msg_t_size -(sizeof(metadata_t
         *)+sizeof(content_t
         *)+2+sizeof(uint32_t)+sizeof(group_t))]
 
   }   zclmsg
 
} _u
 

Detailed Description

Definition at line 33 of file msg.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
more 
command 
ping 
pong 
subscribe 
cancel 
close_cmd 
credential 
routing_id 
shared 

Definition at line 53 of file msg.hpp.

◆ anonymous enum

anonymous enum
Enumerator
msg_t_size 

Definition at line 148 of file msg.hpp.

◆ anonymous enum

anonymous enum
Enumerator
max_vsm_size 

Definition at line 152 of file msg.hpp.

◆ anonymous enum

anonymous enum
Enumerator
ping_cmd_name_size 
cancel_cmd_name_size 
sub_cmd_name_size 

Definition at line 157 of file msg.hpp.

◆ group_type_t

enum zmq::msg_t::group_type_t
private
Enumerator
group_type_short 
group_type_long 

Definition at line 192 of file msg.hpp.

◆ type_t

enum zmq::msg_t::type_t
private
Enumerator
type_min 
type_vsm 
type_lmsg 
type_delimiter 
type_cmsg 
type_zclmsg 
type_join 
type_leave 
type_max 

Definition at line 168 of file msg.hpp.

Member Function Documentation

◆ add_refs()

void zmq::msg_t::add_refs ( int  refs_)

Definition at line 561 of file msg.cpp.

◆ check()

bool zmq::msg_t::check ( ) const

Definition at line 24 of file msg.cpp.

◆ close()

int zmq::msg_t::close ( )

Definition at line 242 of file msg.cpp.

◆ command_body()

void * zmq::msg_t::command_body ( )

Definition at line 541 of file msg.cpp.

◆ command_body_size()

size_t zmq::msg_t::command_body_size ( ) const

Definition at line 526 of file msg.cpp.

◆ copy()

int zmq::msg_t::copy ( msg_t &  src_)

Definition at line 326 of file msg.cpp.

◆ data()

void* zmq::msg_t::data ( )

◆ flags()

unsigned char zmq::msg_t::flags ( ) const

◆ get_routing_id()

uint32_t zmq::msg_t::get_routing_id ( ) const

Definition at line 628 of file msg.cpp.

◆ group()

const char* zmq::msg_t::group ( ) const

◆ init() [1/2]

int zmq::msg_t::init ( )

Definition at line 50 of file msg.cpp.

◆ init() [2/2]

int zmq::msg_t::init ( void *  data_,
size_t  size_,
msg_free_fn *  ffn_,
void *  hint_,
content_t *  content_ = NULL 
)

Definition at line 29 of file msg.cpp.

◆ init_buffer()

int zmq::msg_t::init_buffer ( const void *  buf_,
size_t  size_ 
)

Definition at line 97 of file msg.cpp.

◆ init_cancel()

int zmq::msg_t::init_cancel ( const size_t  size_,
const unsigned char *  topic 
)

Definition at line 227 of file msg.cpp.

◆ init_data()

int zmq::msg_t::init_data ( void *  data_,
size_t  size_,
msg_free_fn *  ffn_,
void *  hint_ 
)

Definition at line 137 of file msg.cpp.

◆ init_delimiter()

int zmq::msg_t::init_delimiter ( )

Definition at line 179 of file msg.cpp.

◆ init_external_storage()

int zmq::msg_t::init_external_storage ( content_t *  content_,
void *  data_,
size_t  size_,
msg_free_fn *  ffn_,
void *  hint_ 
)

Definition at line 111 of file msg.cpp.

◆ init_join()

int zmq::msg_t::init_join ( )

Definition at line 190 of file msg.cpp.

◆ init_leave()

int zmq::msg_t::init_leave ( )

Definition at line 201 of file msg.cpp.

◆ init_size()

int zmq::msg_t::init_size ( size_t  size_)

Definition at line 62 of file msg.cpp.

◆ init_subscribe()

int zmq::msg_t::init_subscribe ( const size_t  size_,
const unsigned char *  topic 
)

Definition at line 212 of file msg.cpp.

◆ is_cancel()

bool zmq::msg_t::is_cancel ( ) const
inline

Definition at line 118 of file msg.hpp.

◆ is_close_cmd()

bool zmq::msg_t::is_close_cmd ( ) const

Definition at line 521 of file msg.cpp.

◆ is_cmsg()

bool zmq::msg_t::is_cmsg ( ) const

Definition at line 486 of file msg.cpp.

◆ is_credential()

bool zmq::msg_t::is_credential ( ) const

Definition at line 471 of file msg.cpp.

◆ is_delimiter()

bool zmq::msg_t::is_delimiter ( ) const

Definition at line 476 of file msg.cpp.

◆ is_join()

bool zmq::msg_t::is_join ( ) const

Definition at line 501 of file msg.cpp.

◆ is_leave()

bool zmq::msg_t::is_leave ( ) const

Definition at line 506 of file msg.cpp.

◆ is_lmsg()

bool zmq::msg_t::is_lmsg ( ) const

Definition at line 491 of file msg.cpp.

◆ is_ping()

bool zmq::msg_t::is_ping ( ) const

Definition at line 511 of file msg.cpp.

◆ is_pong()

bool zmq::msg_t::is_pong ( ) const

Definition at line 516 of file msg.cpp.

◆ is_routing_id()

bool zmq::msg_t::is_routing_id ( ) const

Definition at line 466 of file msg.cpp.

◆ is_subscribe()

bool zmq::msg_t::is_subscribe ( ) const
inline

Definition at line 113 of file msg.hpp.

◆ is_vsm()

bool zmq::msg_t::is_vsm ( ) const

Definition at line 481 of file msg.cpp.

◆ is_zcmsg()

bool zmq::msg_t::is_zcmsg ( ) const

Definition at line 496 of file msg.cpp.

◆ metadata()

metadata_t* zmq::msg_t::metadata ( ) const

◆ move()

int zmq::msg_t::move ( msg_t &  src_)

Definition at line 305 of file msg.cpp.

◆ refcnt()

zmq::atomic_counter_t * zmq::msg_t::refcnt ( )
private

Definition at line 687 of file msg.cpp.

◆ reset_flags()

void zmq::msg_t::reset_flags ( unsigned char  flags_)

Definition at line 438 of file msg.cpp.

◆ reset_metadata()

void zmq::msg_t::reset_metadata ( )

Definition at line 456 of file msg.cpp.

◆ reset_routing_id()

int zmq::msg_t::reset_routing_id ( )

Definition at line 643 of file msg.cpp.

◆ rm_refs()

bool zmq::msg_t::rm_refs ( int  refs_)

Definition at line 584 of file msg.cpp.

◆ set_flags()

void zmq::msg_t::set_flags ( unsigned char  flags_)

Definition at line 433 of file msg.cpp.

◆ set_group() [1/2]

int zmq::msg_t::set_group ( const char *  group_,
size_t  length_ 
)

Definition at line 663 of file msg.cpp.

◆ set_group() [2/2]

int zmq::msg_t::set_group ( const char *  group_)

Definition at line 656 of file msg.cpp.

◆ set_metadata()

void zmq::msg_t::set_metadata ( zmq::metadata_t *  metadata_)

Definition at line 448 of file msg.cpp.

◆ set_routing_id()

int zmq::msg_t::set_routing_id ( uint32_t  routing_id_)

Definition at line 633 of file msg.cpp.

◆ shrink()

void zmq::msg_t::shrink ( size_t  new_size_)

Definition at line 404 of file msg.cpp.

◆ size()

size_t zmq::msg_t::size ( ) const

Member Data Documentation

◆ _u

union { ... } zmq::msg_t::_u

◆ base

struct { ... } zmq::msg_t::base

◆ cmsg

struct { ... } zmq::msg_t::cmsg

◆ content

content_t* zmq::msg_t::content

Definition at line 249 of file msg.hpp.

◆ data [1/2]

void* zmq::msg_t::data

Definition at line 275 of file msg.hpp.

◆ data [2/2]

void * zmq::msg_t::data

Definition at line 239 of file msg.hpp.

◆ delimiter

struct { ... } zmq::msg_t::delimiter

◆ flags

unsigned char zmq::msg_t::flags

Definition at line 232 of file msg.hpp.

◆ group

const char * zmq::msg_t::group

Definition at line 234 of file msg.hpp.

◆ lmsg

struct { ... } zmq::msg_t::lmsg

◆ metadata

zmq::metadata_t * zmq::msg_t::metadata

Definition at line 227 of file msg.hpp.

◆ routing_id

uint32_t zmq::msg_t::routing_id

Definition at line 233 of file msg.hpp.

◆ size [1/2]

size_t zmq::msg_t::size

Definition at line 240 of file msg.hpp.

◆ size [2/2]

size_t zmq::msg_t::size

Definition at line 276 of file msg.hpp.

◆ type

unsigned char zmq::msg_t::type

Definition at line 231 of file msg.hpp.

◆ unused

unsigned char zmq::msg_t::unused[msg_t_size -(sizeof(metadata_t *)+2+sizeof(uint32_t)+sizeof(group_t))]

Definition at line 230 of file msg.hpp.

◆ vsm

struct { ... } zmq::msg_t::vsm

◆ zclmsg

struct { ... } zmq::msg_t::zclmsg
The documentation for this class was generated from the following files:

libaditof
Author(s):
autogenerated on Wed May 21 2025 02:07:11