NIST Biometric Evaluation Framework
Software components for biometric technology evaluations
Public Member Functions | Static Public Attributes | List of all members
BiometricEvaluation::Process::MessageCenterReceiver Class Reference

Receives message from a client, forwarding to the central MessageCenter. More...

#include <be_process_mcreceiver.h>

Inherits BiometricEvaluation::Process::Worker.

Public Member Functions

int32_t workerMain ()
 Receive loop. More...
 
 MessageCenterReceiver ()=default
 Default constructor. More...
 
 ~MessageCenterReceiver ()=default
 Default destructor. More...
 
- Public Member Functions inherited from BiometricEvaluation::Process::Worker
virtual int32_t workerMain ()=0
 The method that will get called to start execution by a ProcessManager. More...
 
std::shared_ptr< void > getParameter (const std::string &name)
 Obtain a parameter passed to this Worker. More...
 
double getParameterAsDouble (const std::string &name)
 Obtain a parameter passed to this Worker as a double. More...
 
int64_t getParameterAsInteger (const std::string &name)
 Obtain a parameter passed to this Worker as an integer. More...
 
std::string getParameterAsString (const std::string &name)
 Obtain a parameter passed to this Worker as a string. More...
 
void setParameter (const std::string &name, std::shared_ptr< void > argument)
 Pass a parameter to this Worker. More...
 
virtual void stop () final
 Tell this Worker to return ASAP. More...
 
void closeWorkerPipeEnds ()
 Perform initialization for communication from Worker to Manager. More...
 
void closeManagerPipeEnds ()
 Perform initialization for communication from Manager to Worker. More...
 
int getSendingPipe () const
 Obtain the pipe used to send messages to this Worker. More...
 
int getReceivingPipe () const
 Obtain the pipe used to receive messages to this Worker. More...
 
void sendMessageToManager (const Memory::uint8Array &message)
 Send a message to the Manager. More...
 
void receiveMessageFromManager (Memory::uint8Array &message)
 Receive a message from the Manager. More...
 
void _initCommunication ()
 Perform general communication initialization from Constructor. More...
 
virtual ~Worker ()
 Worker destructor. More...
 

Static Public Attributes

static const std::string PARAM_CLIENT_SOCKET
 Parameter used to pass client socket FD. More...
 
static const std::string PARAM_CLIENT_ID
 Parameter used to pass an ID to the client. More...
 
static const std::string MSG_DISCONNECT
 Message sent when client should disconnect. More...
 

Additional Inherited Members

- Protected Member Functions inherited from BiometricEvaluation::Process::Worker
 Worker ()
 Worker constructor. More...
 
virtual bool stopRequested () const final
 Determine if the parent has requested this child to exit. More...
 
bool waitForMessage (int numSeconds=-1) const
 Block while waiting for a message from the Manager. More...
 

Detailed Description

Receives message from a client, forwarding to the central MessageCenter.

Definition at line 28 of file be_process_mcreceiver.h.

Constructor & Destructor Documentation

◆ MessageCenterReceiver()

BiometricEvaluation::Process::MessageCenterReceiver::MessageCenterReceiver ( )
default

Default constructor.

◆ ~MessageCenterReceiver()

BiometricEvaluation::Process::MessageCenterReceiver::~MessageCenterReceiver ( )
default

Default destructor.

Member Function Documentation

◆ workerMain()

int32_t BiometricEvaluation::Process::MessageCenterReceiver::workerMain ( )
virtual

Receive loop.

Implements BiometricEvaluation::Process::Worker.

Member Data Documentation

◆ PARAM_CLIENT_SOCKET

const std::string BiometricEvaluation::Process::MessageCenterReceiver::PARAM_CLIENT_SOCKET
static

Parameter used to pass client socket FD.

Definition at line 41 of file be_process_mcreceiver.h.

◆ PARAM_CLIENT_ID

const std::string BiometricEvaluation::Process::MessageCenterReceiver::PARAM_CLIENT_ID
static

Parameter used to pass an ID to the client.

Definition at line 43 of file be_process_mcreceiver.h.

◆ MSG_DISCONNECT

const std::string BiometricEvaluation::Process::MessageCenterReceiver::MSG_DISCONNECT
static

Message sent when client should disconnect.

Definition at line 45 of file be_process_mcreceiver.h.


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