bulkdata::BulkDataReceiver Interface Reference

import "bulkDataReceiver.idl";

Inheritance diagram for bulkdata::BulkDataReceiver:

Collaboration diagram for bulkdata::BulkDataReceiver:

List of all members.

Public Member Functions
void	openReceiver () raises (ACSBulkDataError::AVOpenReceiverErrorEx)
void	openReceiverStream (in string stream_name) raises (ACSBulkDataError::AVOpenReceiverErrorEx)
void	openReceiverStreamCfg (in string stream_name, in string stream_cfg) raises (ACSBulkDataError::AVOpenReceiverErrorEx)
void	openReceiverFlow (in string stream_name, in string flow_name) raises (ACSBulkDataError::AVOpenReceiverErrorEx)
void	openReceiverFlowCfg (in string stream_name, in string flow_name, in string flow_cfg) 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::openReceiverFlow	(	in string	stream_name,
		in string	flow_name
	)			raises (ACSBulkDataError::AVOpenReceiverErrorEx)

Opens/creats a flow with name flown_name on already existing stream with name stream_name. The flow has to be defined in the CDB under alma/<stream_name> in<stream_name>.xml file If you want to create a flow with different configuration plase use openReceiverFlowCfg. This method is implemented just for new bulk data based on DDS (BulkDataNT)

Parameters:

	stream_name	name of the stream where the flow shoudl be created
	flow_name	name of flow that we want to create

Todo:

throw better exceptions

void bulkdata::BulkDataReceiver::openReceiverFlowCfg	(	in string	stream_name,
		in string	flow_name,
		in string	flow_cfg
	)			raises (ACSBulkDataError::AVOpenReceiverErrorEx)

Opens/creats a flow with name flown_name using CDB configuration flow_cfg on already existing stream with name stream_name. There should be a flow configuration in the CDB under alma/<stream_cfg> in<stream_name>.xml file This method is implemented just for new bulk data based on DDS (BulkDataNT)

Parameters:

	stream_name	name of the stream where the flow shoudl be created
	flow_name	name of flow that we want to create
	flow_cfg	name of flow configuration in CDB.

Todo:

throw better exceptions

void bulkdata::BulkDataReceiver::openReceiverStream

(

in string

stream_name

)

raises (ACSBulkDataError::AVOpenReceiverErrorEx)

Opens/creates a stream with name stream_name. The stream has to be defined in the CDB under alma/<stream_name>. If you want to create a stream with different configuration plase use openReceiverStreamCfg. This method is implemented jsut for new bulk data based on DDS (BulkDataNT)

Parameters:

stream_name

name of stream that should be created

Todo:

throw better exception(s)

void bulkdata::BulkDataReceiver::openReceiverStreamCfg	(	in string	stream_name,
		in string	stream_cfg
	)			raises (ACSBulkDataError::AVOpenReceiverErrorEx)

Opens/creates a stream with name stream_name using CDB configuration stream_cfg There should be a stream configuration in the CDB under alma/<stream_cfg>. This method is implemented just for new bulk data based on DDS (BulkDataNT)

Parameters:

	stream_name	name of stream that should be created
	stream_cfg	name of stream configuration in CDB

Todo:

throw better exception(s)

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:

• bulkDataReceiver.idl