Class to manage streamed object. More...

#include <EvtMessage.h>

Public Types
enum	EMessageFlags { c_MsgCompressed = 1 }
	Flags for the message. More...

Public Member Functions
	EvtMessage (char *buf=nullptr)
	build EvtMessage from existing buffer (no copy, but does not take ownership).

	EvtMessage (const char *msg, int size, ERecordType type)
	build EvtMessage by allocating new message buffer (sobjs is copied).

	EvtMessage (const EvtMessage &evtmsg)
	Copy constructor (m_data is copied).

	~EvtMessage ()
	Destructor.

EvtMessage &	operator= (const EvtMessage &obj)
	Assignment (m_data is copied).

char *	buffer ()
	Get buffer address.

void	buffer (const char *)
	Set existing buffer address (copies buffer)

int	size () const
	Get size of message including headers.

int	paddedSize () const
	Same as size(), but as size of an integer array.

int	msg_size () const
	Get size of message body.

unsigned int	getVersion () const
	get version of the header.

unsigned int	getMsgFlags () const
	Get flags of the message.

void	setMsgFlags (unsigned int flags)
	Set flags for the message.

void	addMsgFlags (unsigned int flags)
	Add flags to the message.

bool	hasMsgFlags (unsigned int flags) const
	Check if the message has the given flags.

ERecordType	type () const
	Get record type.

void	type (ERecordType)
	Set record type.

struct timeval	time () const
	Get time stamp.

void	setTime (const struct timeval &time)
	Set time stamp.

int	src () const
	Get source IP of message.

void	src (int src)
	Set source IP of message.

int	dest () const
	Get destination IP of message.

void	dest (int dest)
	Set destination IP of message.

EvtHeader *	header ()
	Get pointer to EvtHeader.

const EvtHeader *	getHeader () const
	Get pointer to EvtHeader.

char *	msg ()
	Get pointer to message body.

Static Public Attributes
static const unsigned int	c_MaxEventSize = 200000000
	maximal EvtMessage size, in bytes (200MB).

Private Member Functions
void	setMsg (const char *msg, int size, ERecordType type)
	Copy message into newly allocated buffer.

Private Attributes
char *	m_data
	Pointer to the internal EvtMessage buffer.

bool	m_ownsBuffer
	Wether to clean up m_data in destructor.

Detailed Description

Class to manage streamed object.

Binary stream consists of: Fields in EvtHeader (see definition) List of streamed objects, each consisting of: word 1 : size of object word 2- : streamed object

Definition at line 59 of file EvtMessage.h.

Member Enumeration Documentation

◆ EMessageFlags

enum EMessageFlags

Flags for the message.

Enumerator
c_MsgCompressed	indicates that the message body is compressed and should be uncompressed using ROOT R__unzip_header and R__unzip before use

Definition at line 66 of file EvtMessage.h.

                       {
      c_MsgCompressed = 1
    };

Constructor & Destructor Documentation

◆ EvtMessage() [1/3]

EvtMessage ( char * buf = nullptr )

explicit

build EvtMessage from existing buffer (no copy, but does not take ownership).

Definition at line 27 of file EvtMessage.cc.

                                :
  m_data(data),
  m_ownsBuffer(false)
{
}

◆ EvtMessage() [2/3]

EvtMessage	(	const char *	msg,
		int	size,
		ERecordType	type = `MSG_EVENT`
	)

build EvtMessage by allocating new message buffer (sobjs is copied).

Constructor of EvtMessage allocating new buffer.

Parameters

msg	data
size	Length of the data (TMessage)
type	type of the message

Definition at line 37 of file EvtMessage.cc.

{
  int fullsize = size + sizeof(EvtHeader);
  int bufsize = roundToNearestInt(fullsize);
  m_data = new char[bufsize]; // Allocate new buffer
  // zero extra bytes
  memset(m_data + fullsize, 0, bufsize - fullsize);
  setMsg(msg, size, type);
  m_ownsBuffer = true;
}

◆ EvtMessage() [3/3]

EvtMessage ( const EvtMessage & evtmsg )

Copy constructor (m_data is copied).

Copy constructor of EvtMessage class.

Parameters

evtmsg Original EvtMessage object

Definition at line 50 of file EvtMessage.cc.

{
  *this = evtmsg;
}

◆ ~EvtMessage()

~EvtMessage ( )

Destructor.

Destructor of EvtMessage class.

Definition at line 56 of file EvtMessage.cc.

{
  if (m_ownsBuffer)
    delete [] m_data;
}

Member Function Documentation

◆ addMsgFlags()

void addMsgFlags ( unsigned int flags )

inline

Add flags to the message.

Definition at line 113 of file EvtMessage.h.

113{ header()->flags |= flags;}

Belle2::EvtMessage::header

EvtHeader * header()

Get pointer to EvtHeader.

Definition: EvtMessage.cc:161

Belle2::EvtHeader::flags

UInt_t flags

flags concerning the content of the message.

Definition: EvtMessage.h:37

◆ buffer() [1/2]

char * buffer ( )

Get buffer address.

If you own the EvtMessage object, the memory is guaranteed to be at least sizeof(int) * paddedSize() bytes. Bytes exceeding size() are zeroed.

Definition at line 76 of file EvtMessage.cc.

{
  return m_data;
}

◆ buffer() [2/2]

void buffer ( const char * bufadr )

Set existing buffer address (copies buffer)

Definition at line 81 of file EvtMessage.cc.

{
  UInt_t size = *(UInt_t*)bufadr;
  int bufsize = roundToNearestInt(size);
  m_data = new char[bufsize];
  memcpy(m_data, bufadr, size);
  for (int i = bufsize - size; i > 0; i--)
    m_data[bufsize - i] = '\0'; //zero extra bytes
  m_ownsBuffer = true;
}

◆ dest() [1/2]

int dest ( ) const

Get destination IP of message.

Definition at line 136 of file EvtMessage.cc.

{
  return ((reinterpret_cast<EvtHeader*>(m_data))->dest);
}

◆ dest() [2/2]

void dest ( int dest )

Set destination IP of message.

Definition at line 141 of file EvtMessage.cc.

{
  (reinterpret_cast<EvtHeader*>(m_data))->dest = dest;
}

◆ getHeader()

const EvtHeader * getHeader ( ) const

Get pointer to EvtHeader.

Definition at line 166 of file EvtMessage.cc.

{
  return (reinterpret_cast<const EvtHeader*>(m_data));
}

◆ getMsgFlags()

unsigned int getMsgFlags ( ) const

inline

Get flags of the message.

Definition at line 109 of file EvtMessage.h.

109{ return getVersion() > 0 ? getHeader()->flags : 0; }

Belle2::EvtMessage::getVersion

unsigned int getVersion() const

get version of the header.

Definition: EvtMessage.h:107

Belle2::EvtMessage::getHeader

const EvtHeader * getHeader() const

Get pointer to EvtHeader.

Definition: EvtMessage.cc:166

◆ getVersion()

unsigned int getVersion ( ) const

inline

get version of the header.

Returns 0 for no valid version information

Definition at line 107 of file EvtMessage.h.

107{ return ((getHeader()->version & 0xFFFFFF00) == 0xBEEFED00) ? (getHeader()->version & 0xFF) : 0;}

Belle2::EvtHeader::version

UInt_t version

version field.

Definition: EvtMessage.h:48

◆ hasMsgFlags()

bool hasMsgFlags ( unsigned int flags ) const

inline

Check if the message has the given flags.

Definition at line 115 of file EvtMessage.h.

115{ return (getMsgFlags() & flags) == flags; }

Belle2::EvtMessage::getMsgFlags

unsigned int getMsgFlags() const

Get flags of the message.

Definition: EvtMessage.h:109

◆ header()

EvtHeader * header ( )

Get pointer to EvtHeader.

Definition at line 161 of file EvtMessage.cc.

{
  return (reinterpret_cast<EvtHeader*>(m_data));
}

◆ msg()

char * msg ( )

Get pointer to message body.

Definition at line 172 of file EvtMessage.cc.

{
  return (m_data + sizeof(EvtHeader));
}

◆ msg_size()

int msg_size ( ) const

Get size of message body.

Definition at line 108 of file EvtMessage.cc.

{
  return ((reinterpret_cast<EvtHeader*>(m_data))->size - sizeof(EvtHeader));
}

◆ operator=()

EvtMessage & operator= ( const EvtMessage & obj )

Assignment (m_data is copied).

Overridden assign operator.

Parameters

obj	Source object

Definition at line 64 of file EvtMessage.cc.

{
  if (this != &obj) {
    if (m_ownsBuffer)
      delete [] m_data;
    buffer(obj.m_data); //copy m_data
    m_ownsBuffer = true; //already set by buffer(), but let's be explicit
  }
 
  return *this;
}

◆ paddedSize()

int paddedSize ( ) const

Same as size(), but as size of an integer array.

Use this for passing EvtMessage to RingBuffer::insq().

Definition at line 99 of file EvtMessage.cc.

{
  const int sizeBytes = size();
  //round up to next int boundary
  return roundToNearestInt(sizeBytes) / sizeof(int);
}

◆ setMsg()

void setMsg	(	const char *	msg,
		int	size,
		ERecordType	type
	)

private

Copy message into newly allocated buffer.

Definition at line 179 of file EvtMessage.cc.

{
  //initialize message header properly
  new (m_data) EvtHeader(size + sizeof(EvtHeader), type);
  struct timeval tv;
  gettimeofday(&tv, nullptr);
  this->setTime(tv);
  if (size > 0)
    memcpy(m_data + sizeof(EvtHeader), msgin, size);
}

◆ setMsgFlags()

void setMsgFlags ( unsigned int flags )

inline

Set flags for the message.

Definition at line 111 of file EvtMessage.h.

111{ header()->flags = flags;}

◆ setTime()

void setTime ( const struct timeval & time )

Set time stamp.

Definition at line 154 of file EvtMessage.cc.

{
  (reinterpret_cast<EvtHeader*>(m_data))->time_sec = tbuf.tv_sec;
  (reinterpret_cast<EvtHeader*>(m_data))->time_usec = tbuf.tv_usec;
}

◆ size()

int size ( ) const

Get size of message including headers.

Often, you'll want to use paddedSize() instead.

Definition at line 94 of file EvtMessage.cc.

{
  return ((reinterpret_cast<EvtHeader*>(m_data))->size);
}

◆ src() [1/2]

int src ( ) const

Get source IP of message.

Definition at line 125 of file EvtMessage.cc.

{
  return ((reinterpret_cast<EvtHeader*>(m_data))->src);
}

◆ src() [2/2]

void src ( int src )

Set source IP of message.

Definition at line 130 of file EvtMessage.cc.

{
  (reinterpret_cast<EvtHeader*>(m_data))->src = src;
}

◆ time()

struct timeval time ( ) const

Get time stamp.

Definition at line 147 of file EvtMessage.cc.

                                      {
  struct timeval tv;
  tv.tv_sec = (reinterpret_cast<EvtHeader*>(m_data))->time_sec;
  tv.tv_usec = (reinterpret_cast<EvtHeader*>(m_data))->time_usec;
  return tv;
}

◆ type() [1/2]

ERecordType type ( ) const

Get record type.

Definition at line 114 of file EvtMessage.cc.

{
  return ((reinterpret_cast<EvtHeader*>(m_data))->rectype);
}

◆ type() [2/2]

void type ( ERecordType type )

Set record type.

Definition at line 119 of file EvtMessage.cc.

{
  (reinterpret_cast<EvtHeader*>(m_data))->rectype = type;
}

Member Data Documentation

◆ c_MaxEventSize

const unsigned int c_MaxEventSize = 200000000

static

maximal EvtMessage size, in bytes (200MB).

Definition at line 63 of file EvtMessage.h.

◆ m_data

char* m_data

private

Pointer to the internal EvtMessage buffer.

Definition at line 148 of file EvtMessage.h.

◆ m_ownsBuffer

bool m_ownsBuffer

private

Wether to clean up m_data in destructor.

Definition at line 149 of file EvtMessage.h.

The documentation for this class was generated from the following files:

framework/pcore/include/EvtMessage.h
framework/pcore/src/EvtMessage.cc

Public Types

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ EMessageFlags

Constructor & Destructor Documentation

◆ EvtMessage() [1/3]

◆ EvtMessage() [2/3]

◆ EvtMessage() [3/3]

◆ ~EvtMessage()

Member Function Documentation

◆ addMsgFlags()

◆ buffer() [1/2]

◆ buffer() [2/2]

◆ dest() [1/2]

◆ dest() [2/2]

◆ getHeader()

◆ getMsgFlags()

◆ getVersion()

◆ hasMsgFlags()

◆ header()

◆ msg()

◆ msg_size()

◆ operator=()

◆ paddedSize()

◆ setMsg()

◆ setMsgFlags()

◆ setTime()

◆ size()

◆ src() [1/2]

◆ src() [2/2]

◆ time()

◆ type() [1/2]

◆ type() [2/2]

Member Data Documentation

◆ c_MaxEventSize

◆ m_data

◆ m_ownsBuffer