TMEventBuffer Class Reference

#include <tmfe.h>

Collaboration diagram for TMEventBuffer:

Public Member Functions
	TMEventBuffer (TMFE *mfe)
	~TMEventBuffer ()
TMFeResult	OpenBuffer (const char *bufname, size_t bufsize=0)
TMFeResult	CloseBuffer ()
TMFeResult	SetCacheSize (size_t read_cache_size, size_t write_cache_size)
TMFeResult	AddRequest (int event_id, int trigger_mask, const char *sampling_type_string)
TMFeResult	ReceiveEvent (std::vector< char > *e, int timeout_msec=0)
TMFeResult	SendEvent (const char *e)
TMFeResult	SendEvent (const std::vector< char > &e)
TMFeResult	SendEvent (const std::vector< std::vector< char > > &e)
TMFeResult	SendEvent (int sg_n, const char *const sg_ptr[], const size_t sg_len[])
TMFeResult	FlushCache (bool wait=true)

Public Attributes
TMFE *	fMfe = NULL
std::string	fBufName
size_t	fBufSize = 0
size_t	fBufMaxEventSize = 0
int	fBufHandle = 0
size_t	fBufReadCacheSize = 0
size_t	fBufWriteCacheSize = 0
std::vector< int >	fBufRequests

Detailed Description

Definition at line 115 of file tmfe.h.

Constructor & Destructor Documentation

TMEventBuffer()

TMEventBuffer::TMEventBuffer

(

TMFE *

mfe

)

Definition at line 169 of file tmfe.cxx.

{
   assert(mfe != NULL);
   fMfe = mfe;
};

Here is the call graph for this function:

~TMEventBuffer()

TMEventBuffer::~TMEventBuffer

(

)

Definition at line 175 of file tmfe.cxx.

{
   CloseBuffer();
 
   // poison all pointers
   fMfe = NULL;
};

Here is the call graph for this function:

Member Function Documentation

AddRequest()

TMFeResult TMEventBuffer::AddRequest	(	int	event_id,
		int	trigger_mask,
		const char *	sampling_type_string
	)

Definition at line 272 of file tmfe.cxx.

{
   if (!fBufHandle) {
      return TMFeErrorMessage(msprintf("AddRequest: Error: Event buffer \"%s\" is not open", fBufName.c_str()));
   }
 
   int sampling_type = 0;
   
   if (strcmp(sampling_type_string, "GET_ALL")==0) {
      sampling_type = GET_ALL;
   } else if (strcmp(sampling_type_string, "GET_NONBLOCKING")==0) {
      sampling_type = GET_NONBLOCKING;
   } else if (strcmp(sampling_type_string, "GET_RECENT")==0) {
      sampling_type = GET_RECENT;
   } else {
      sampling_type = GET_ALL;
   }
   
   int request_id = 0;
      
   int status = bm_request_event(fBufHandle, event_id, trigger_mask, sampling_type, &request_id, NULL);
   
   if (status != BM_SUCCESS) {
      return TMFeMidasError(msprintf("Cannot make event request on buffer \"%s\"", fBufName.c_str()), "bm_request_event", status);
   }
   
   fBufRequests.push_back(request_id);
   
   return TMFeOk();
}

Here is the call graph for this function:

CloseBuffer()

TMFeResult TMEventBuffer::CloseBuffer

(

)

Definition at line 235 of file tmfe.cxx.

{
   if (!fBufHandle)
      return TMFeOk();
   
   fBufRequests.clear(); // no need to cancel individual requests, they are gone after we close the buffer
   
   int status = bm_close_buffer(fBufHandle);
   
   if (status != BM_SUCCESS) {
      fBufHandle = 0;
      return TMFeMidasError(msprintf("Cannot close event buffer \"%s\"", fBufName.c_str()), "bm_close_buffer", status);
   }
   
   fBufHandle = 0;
   fBufSize = 0;
   fBufMaxEventSize = 0;
   fBufReadCacheSize = 0;
   fBufWriteCacheSize = 0;
   
   return TMFeOk();
}

Here is the call graph for this function:

Here is the caller graph for this function:

FlushCache()

TMFeResult TMEventBuffer::FlushCache

(

bool

wait = true

)

Definition at line 374 of file tmfe.cxx.

{
   if (!fBufHandle)
      return TMFeOk();
   
   int flag = BM_NO_WAIT;
   if (wait)
      flag = BM_WAIT;
   
   /* flush of event socket in no-wait mode does nothing */
   if (wait && rpc_is_remote()) {
      int status = bm_flush_cache(0, flag);
 
      //printf("bm_flush_cache(0,%d) status %d\n", flag, status);
 
      if (status == BM_SUCCESS) {
         // nothing
      } else if (status == BM_ASYNC_RETURN) {
         // nothing
      } else {
         return TMFeMidasError("Cannot flush mserver event socket", "bm_flush_cache", status);
      }
   }
 
   int status = bm_flush_cache(fBufHandle, flag);
 
   //printf("bm_flush_cache(%d,%d) status %d\n", fBufHandle, flag, status);
 
   if (status == BM_SUCCESS) {
      // nothing
   } else if (status == BM_ASYNC_RETURN) {
      // nothing
   } else {
      return TMFeMidasError(msprintf("Cannot flush event buffer \"%s\"", fBufName.c_str()).c_str(), "bm_flush_cache", status);
   }
 
   return TMFeOk();
}

Here is the call graph for this function:

OpenBuffer()

TMFeResult TMEventBuffer::OpenBuffer	(	const char *	bufname,
		size_t	bufsize = 0
	)

Definition at line 183 of file tmfe.cxx.

{
   if (fBufHandle) {
      return TMFeErrorMessage(msprintf("Event buffer \"%s\" is already open", fBufName.c_str()));
   }
   
   fBufName = bufname;
 
   if (bufsize == 0)
      bufsize = DEFAULT_BUFFER_SIZE;
 
   int status = bm_open_buffer(fBufName.c_str(), bufsize, &fBufHandle);
 
   if (status != BM_SUCCESS && status != BM_CREATED) {
      return TMFeMidasError(msprintf("Cannot open event buffer \"%s\"", fBufName.c_str()), "bm_open_buffer", status);
   }
 
   fBufSize = 0;
   fBufMaxEventSize = 0;
 
   uint32_t buf_size = 0;
   uint32_t max_event_size = 0;
 
   fMfe->fOdbRoot->RU32("Experiment/MAX_EVENT_SIZE", &max_event_size);
   fMfe->fOdbRoot->RU32((std::string("Experiment/Buffer Sizes/") + bufname).c_str(), &buf_size);
 
   if (buf_size > 0) {
      // limit event size to half the buffer size, so we can buffer two events
      uint32_t xmax_event_size = buf_size / 2;
      // add extra margin
      if (xmax_event_size > 1024)
         xmax_event_size -= 1024;
      if (max_event_size > xmax_event_size)
         max_event_size = xmax_event_size;
   }
 
   fBufSize = buf_size;
   fBufMaxEventSize = max_event_size;
 
   if (fBufSize == 0) {
      return TMFeErrorMessage(msprintf("Cannot get buffer size for event buffer \"%s\"", fBufName.c_str()));
   }
 
   if (fBufMaxEventSize == 0) {
      return TMFeErrorMessage(msprintf("Cannot get MAX_EVENT_SIZE for event buffer \"%s\"", fBufName.c_str()));
   }
 
   printf("TMEventBuffer::OpenBuffer: Buffer \"%s\" size %d, max event size %d\n", fBufName.c_str(), (int)fBufSize, (int)fBufMaxEventSize);
 
   return TMFeOk();
}

Here is the call graph for this function:

Here is the caller graph for this function:

ReceiveEvent()

TMFeResult TMEventBuffer::ReceiveEvent	(	std::vector< char > *	e,
		int	timeout_msec = 0
	)

Definition at line 303 of file tmfe.cxx.

{
   if (!fBufHandle) {
      return TMFeErrorMessage(msprintf("ReceiveEvent: Error: Event buffer \"%s\" is not open", fBufName.c_str()));
   }
 
   assert(e != NULL);
   
   e->resize(0);
   
   int status = bm_receive_event_vec(fBufHandle, e, timeout_msec);
   
   if (status == BM_ASYNC_RETURN) {
      return TMFeOk();
   }
   
   if (status != BM_SUCCESS) {
      return TMFeMidasError(msprintf("Cannot receive event on buffer \"%s\"", fBufName.c_str()), "bm_receive_event", status);
   }
   
   return TMFeOk();
}

Here is the call graph for this function:

SendEvent() [1/4]

TMFeResult TMEventBuffer::SendEvent

(

const char *

e

)

Definition at line 326 of file tmfe.cxx.

{
   const EVENT_HEADER *pevent = (const EVENT_HEADER*)e;
   const size_t event_size = sizeof(EVENT_HEADER) + pevent->data_size;
   //const size_t total_size = ALIGN8(event_size);
   return SendEvent(1, &e, &event_size);
}

Here is the call graph for this function:

Here is the caller graph for this function:

SendEvent() [2/4]

TMFeResult TMEventBuffer::SendEvent

(

const std::vector< char > &

e

)

Definition at line 334 of file tmfe.cxx.

{
   const EVENT_HEADER *pevent = (const EVENT_HEADER*)e.data();
   const size_t event_size = sizeof(EVENT_HEADER) + pevent->data_size;
   //const size_t total_size = ALIGN8(event_size);
   if (e.size() != event_size) {
      return TMFeErrorMessage(msprintf("Cannot send event, size mismatch: vector size %d, data_size %d, event_size %d", (int)e.size(), (int)pevent->data_size, (int)event_size).c_str());
   }
 
   return SendEvent(1, (char**)&pevent, &event_size);
}

Here is the call graph for this function:

SendEvent() [3/4]

TMFeResult TMEventBuffer::SendEvent

(

const std::vector< std::vector< char > > &

e

)

Definition at line 346 of file tmfe.cxx.

{
   int sg_n = e.size();
   const char* sg_ptr[sg_n];
   size_t sg_len[sg_n];
   for (int i=0; i<sg_n; i++) {
      sg_ptr[i] = e[i].data();
      sg_len[i] = e[i].size();
   }
   return SendEvent(sg_n, sg_ptr, sg_len);
}

Here is the call graph for this function:

SendEvent() [4/4]

TMFeResult TMEventBuffer::SendEvent	(	int	sg_n,
		const char *const	sg_ptr[],
		const size_t	sg_len[]
	)

Definition at line 358 of file tmfe.cxx.

{
   int status = bm_send_event_sg(fBufHandle, sg_n, sg_ptr, sg_len, BM_WAIT);
 
   if (status == BM_CORRUPTED) {
      fMfe->Msg(MERROR, "TMEventBuffer::SendEvent", "Cannot send event to buffer \"%s\": bm_send_event() returned %d, event buffer is corrupted, shutting down the frontend", fBufName.c_str(), status);
      fMfe->fShutdownRequested = true;
      return TMFeMidasError("Cannot send event, event buffer is corrupted, shutting down the frontend", "bm_send_event", status);
   } else if (status != BM_SUCCESS) {
      fMfe->Msg(MERROR, "TMEventBuffer::SendEvent", "Cannot send event to buffer \"%s\": bm_send_event() returned %d", fBufName.c_str(), status);
      return TMFeMidasError("Cannot send event", "bm_send_event", status);
   }
 
   return TMFeOk();
}

Here is the call graph for this function:

SetCacheSize()

TMFeResult TMEventBuffer::SetCacheSize	(	size_t	read_cache_size,
		size_t	write_cache_size
	)

Definition at line 258 of file tmfe.cxx.

{
   int status = bm_set_cache_size(fBufHandle, read_cache_size, write_cache_size);
   
   if (status != BM_SUCCESS) {
      return TMFeMidasError(msprintf("Cannot set event buffer \"%s\" cache sizes: read %d, write %d", fBufName.c_str(), (int)read_cache_size, (int)write_cache_size), "bm_set_cache_size", status);
   }
 
   fBufReadCacheSize = read_cache_size;
   fBufWriteCacheSize = write_cache_size;
   
   return TMFeOk();
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

fBufHandle

int TMEventBuffer::fBufHandle = 0

Definition at line 138 of file tmfe.h.

fBufMaxEventSize

size_t TMEventBuffer::fBufMaxEventSize = 0

Definition at line 121 of file tmfe.h.

fBufName

std::string TMEventBuffer::fBufName

Definition at line 119 of file tmfe.h.

fBufReadCacheSize

size_t TMEventBuffer::fBufReadCacheSize = 0

Definition at line 139 of file tmfe.h.

fBufRequests

std::vector<int> TMEventBuffer::fBufRequests

Definition at line 141 of file tmfe.h.

fBufSize

size_t TMEventBuffer::fBufSize = 0

Definition at line 120 of file tmfe.h.

fBufWriteCacheSize

size_t TMEventBuffer::fBufWriteCacheSize = 0

Definition at line 140 of file tmfe.h.

fMfe

TMFE* TMEventBuffer::fMfe = NULL

Definition at line 118 of file tmfe.h.

---

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

• include/tmfe.h
• src/tmfe.cxx