AcsBulkdata::BulkDataNTCallback

NAME
SYNOPSIS
Constructor & Destructor Documentation
Member Function Documentation
Member Data Documentation
Author

NAME

AcsBulkdata::BulkDataNTCallback −

SYNOPSIS

#include <bulkDataNTCallback.h>

Public Member Functions

virtual ~BulkDataNTCallback ()

void setFlowName (const char *name)

const char * getFlowName ()

void setStreamName (const char *name)

const char * getStreamName ()

void setReceiverName (ACE_CString &name)

void setReceiverName (const char *name)

const char * getReceiverName ()

void setCBReceiveProcessTimeout (double to)

double getCBReceiveProcessTimeout ()

void setCBReceiveAvgProcessTimeout (double to)

double getCBReceiveAvgProcessTimeout ()

virtual int cbStart (unsigned char *userParam_p=0, unsigned int size=0)=0

virtual int cbReceive (unsigned char *frame_p, unsigned int size)=0

virtual int cbStop ()=0

virtual void onError (ACSErr::CompletionImpl &error)

virtual void onSenderConnect (unsigned short totalSeners)

virtual void onSenderDisconnect (unsigned short totalSeners)

virtual void onDataLost (unsigned long frameCount, unsigned long totalFrames, ACSErr::CompletionImpl &error)

Protected Attributes

std::string flowName_m

std::string streamName_m

ACE_CString recvName_m

double cbReceiveProcessTimeout_m

double cbReceiveAvgProcessTimeout_m

Constructor & Destructor Documentation

virtual AcsBulkdata::BulkDataNTCallback::~BulkDataNTCallback () [inline, virtual]

Member Function Documentation

virtual int AcsBulkdata::BulkDataNTCallback::cbReceive (unsigned char * frame_p, unsigned int size) [pure virtual]

virtual int AcsBulkdata::BulkDataNTCallback::cbStart (unsigned char * userParam_p = 0, unsigned int size = 0) [pure virtual]

virtual int AcsBulkdata::BulkDataNTCallback::cbStop () [pure virtual]

double AcsBulkdata::BulkDataNTCallback::getCBReceiveAvgProcessTimeout () [inline] * getter for cbReceiveAvgProcessTimeout_m

Returns:

timeout in sec

References cbReceiveAvgProcessTimeout_m.

double AcsBulkdata::BulkDataNTCallback::getCBReceiveProcessTimeout () [inline] * getter for cbReceiveProcessTimeout_m

Returns:

timeout in sec

References cbReceiveProcessTimeout_m.

const char* AcsBulkdata::BulkDataNTCallback::getFlowName () [inline]

References flowName_m.

const char* AcsBulkdata::BulkDataNTCallback::getReceiverName () [inline]

References recvName_m.

const char* AcsBulkdata::BulkDataNTCallback::getStreamName () [inline]

References streamName_m.

virtual void AcsBulkdata::BulkDataNTCallback::onDataLost (unsigned long frameCount, unsigned long totalFrames, ACSErr::CompletionImpl & error) [virtual] The method is called when a frame (DDS sample) did not arrive. The default implementation just log the completion.

Parameters:

frmaeCount - missed frame number/count
totalFrames
- total number of frames that should arrived
error
completion: SampleLostCompletion, if detected by DDS or FrameLostCompletion if detected by BD

virtual void AcsBulkdata::BulkDataNTCallback::onError (ACSErr::CompletionImpl & error) [virtual] This method is called when an error happens in the flow’s callback (cbStart/cbReceive/cbStop), and can be overridden by an user. The default implementation just logs the error completion.

Parameters:

error - at the moment possible completion errors are: WrongFrameOrderCompletion UnknownDataTypeCompletion DDSReturnErrorCompletion CBReceiveProcessTimeoutCompletion DDSRequestedDeadlineMissedCompletion Requested DDSRequestedIncompatibleQoSCompletion

virtual void AcsBulkdata::BulkDataNTCallback::onSenderConnect (unsigned short totalSeners) [inline, virtual] The method is called when a new sender is connected to a flow

Parameters:

totalSeners new number os senders after connect

virtual void AcsBulkdata::BulkDataNTCallback::onSenderDisconnect (unsigned short totalSeners) [inline, virtual] The method is called when a sender is disconnected for a flow

Parameters:

totalSeners new number of senders, after disconnect

void AcsBulkdata::BulkDataNTCallback::setCBReceiveAvgProcessTimeout (double to) setter method for cbReceiveAvgProcessTimeout_m

Parameters:

to - average cbReceiver process time in sec

void AcsBulkdata::BulkDataNTCallback::setCBReceiveProcessTimeout (double to) setter method for cbReceiveProcessTimeout_m

Parameters:

to - maximal cbReceiver process time in sec

void AcsBulkdata::BulkDataNTCallback::setFlowName (const char * name) [inline]

References flowName_m.

void AcsBulkdata::BulkDataNTCallback::setReceiverName (ACE_CString & name) [inline]

References recvName_m.

void AcsBulkdata::BulkDataNTCallback::setReceiverName (const char * name) [inline]

References recvName_m.

void AcsBulkdata::BulkDataNTCallback::setStreamName (const char * name) [inline]

References streamName_m.

Member Data Documentation

double AcsBulkdata::BulkDataNTCallback::cbReceiveAvgProcessTimeout_m [protected]

Referenced by getCBReceiveAvgProcessTimeout().

double AcsBulkdata::BulkDataNTCallback::cbReceiveProcessTimeout_m [protected]

Referenced by getCBReceiveProcessTimeout().

std::string AcsBulkdata::BulkDataNTCallback::flowName_m [protected]

Referenced by getFlowName(), and setFlowName().

ACE_CString AcsBulkdata::BulkDataNTCallback::recvName_m [protected]

Referenced by getReceiverName(), and setReceiverName().

std::string AcsBulkdata::BulkDataNTCallback::streamName_m [protected]

Referenced by getStreamName(), and setStreamName().

Author

Generated automatically by Doxygen for ACS-2015.2 C++ API from the source code.