Public Member Functions

bulkdata::BulkDataReceiver Interface Reference

import "bulkDataReceiver.idl";

Inheritance diagram for bulkdata::BulkDataReceiver:
Inheritance graph
[legend]
Collaboration diagram for bulkdata::BulkDataReceiver:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void openReceiver () raises (ACSBulkDataError::AVOpenReceiverErrorEx)
void openReceiverStream (in string stream_name) raises (ACSBulkDataError::AVOpenReceiverErrorEx)
BulkDataReceiverConfig getReceiverConfig () raises (ACSBulkDataError::AVReceiverConfigErrorEx)
void closeReceiver () raises (ACSBulkDataError::AVCloseReceiverErrorEx)
void closeReceiverStream (in string stream_name) raises (ACSBulkDataError::AVCloseReceiverErrorEx)
ACSErr::Completion getCbStatus (in unsigned long flowNumber) raises (ACSBulkDataError::AVInvalidFlowNumberEx, ACSBulkDataError::AVFlowEndpointErrorEx)
void setTimeout (in unsigned long flowNumber, in unsigned long timeout) raises (ACSBulkDataError::AVInvalidFlowNumberEx, ACSBulkDataError::AVFlowEndpointErrorEx)
void setRecvName (in string recvName) raises (ACSBulkDataError::AVSetReceiverNameErrorEx)
void subscribeNotification (in ACS::CBvoid notifCb) raises (ACSBulkDataError::AVNotificationMechanismErrorEx)
void fwdData2UserCB (in boolean enable)

Detailed Description

Defines the interface for the Bulk Data Receiver Component


Member Function Documentation

void bulkdata::BulkDataReceiver::closeReceiver (  )  raises (ACSBulkDataError::AVCloseReceiverErrorEx)

Closes connection.......

Returns:
void

void bulkdata::BulkDataReceiver::closeReceiverStream ( in string  stream_name  )  raises (ACSBulkDataError::AVCloseReceiverErrorEx)
void bulkdata::BulkDataReceiver::fwdData2UserCB ( in boolean  enable  ) 

Enable or disable that data are sent/forwarded to the user's CB. By default this is enable. This operation has to be use with caution for debugging purposes only!!! The operation has effect only if it is ivoked after the connection with the receiver has been established i.e. the callback object has been created !!

Parameters:
enable true -> data will be sent to the user's CB, false -> data will *not* be sent to the user's CB,
Returns:
void

ACSErr::Completion bulkdata::BulkDataReceiver::getCbStatus ( in unsigned long  flowNumber  )  raises (ACSBulkDataError::AVInvalidFlowNumberEx, ACSBulkDataError::AVFlowEndpointErrorEx)

Get callback status

Returns:
ACSErr::Completion

BulkDataReceiverConfig bulkdata::BulkDataReceiver::getReceiverConfig (  )  raises (ACSBulkDataError::AVReceiverConfigErrorEx)

This property is the Receiver Steam End Point.

void bulkdata::BulkDataReceiver::openReceiver (  )  raises (ACSBulkDataError::AVOpenReceiverErrorEx)

Opens connection creating an out-of-bound channel using TAO A/V services. It creates the Receiver Stream End Point and Flow End Point for the connection with the Sender. The Receiver Stream End Point can be retrieved as an attribute.

Returns:
void

void bulkdata::BulkDataReceiver::openReceiverStream ( in string  stream_name  )  raises (ACSBulkDataError::AVOpenReceiverErrorEx)
void bulkdata::BulkDataReceiver::setRecvName ( in string  recvName  )  raises (ACSBulkDataError::AVSetReceiverNameErrorEx)

Set receiver name in receiver callback

Parameters:
recName receiver name.
Returns:
void

void bulkdata::BulkDataReceiver::setTimeout ( in unsigned long  flowNumber,
in unsigned long  timeout 
) raises (ACSBulkDataError::AVInvalidFlowNumberEx, ACSBulkDataError::AVFlowEndpointErrorEx)

Set receiver timeout

Returns:
void

void bulkdata::BulkDataReceiver::subscribeNotification ( in ACS::CBvoid  notifCb  )  raises (ACSBulkDataError::AVNotificationMechanismErrorEx)

Subscribe to the Notification Mechanism

Parameters:
notifCb receiver name.
Returns:
void


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