cis_config
Public Member Functions | List of all members
PsiOutput Class Reference

C++ interface to psiOutput_t functionality. More...

#include <PsiInterface.hpp>

Public Member Functions

 PsiOutput (const char *name)
 Constructor for PsiOutput. More...
 
int send (char *data, int len)
 Send a message smaller than PSI_MSG_MAX to the output queue. If the message is larger than PSI_MSG_MAX an error code will be returned. See psi_send in PsiInterface.h for details. More...
 
int send_nolimit (char *data, int len)
 Send a message larger than PSI_MSG_MAX to the output queue. See psi_send_nolimit in PsiInterface.h for details. More...
 

Detailed Description

C++ interface to psiOutput_t functionality.

The PsiOutput class is a basic wrapper around the C psiOutput_t structure and associated functions from the PsiInterface.h header. It provides the user with C++ style access to basic output via an IPC queue.

Constructor & Destructor Documentation

◆ PsiOutput()

PsiOutput::PsiOutput ( const char *  name)
inline

Constructor for PsiOutput.

Parameters
[in]nameconstant character pointer to name of output queue. This should be the argument to an output driver in the yaml specification file.

Member Function Documentation

◆ send()

int PsiOutput::send ( char *  data,
int  len 
)
inline

Send a message smaller than PSI_MSG_MAX to the output queue. If the message is larger than PSI_MSG_MAX an error code will be returned. See psi_send in PsiInterface.h for details.

Parameters
[in]datacharacter pointer to message that should be sent.
[in]lenint length of message to be sent.
Returns
int 0 if send succesfull, -1 if send unsuccessful.

◆ send_nolimit()

int PsiOutput::send_nolimit ( char *  data,
int  len 
)
inline

Send a message larger than PSI_MSG_MAX to the output queue. See psi_send_nolimit in PsiInterface.h for details.

Parameters
[in]datacharacter pointer to message that should be sent.
[in]lenint length of message to be sent.
Returns
int 0 if send succesfull, -1 if send unsuccessful.

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