jp.go.aist.rtm.RTC.port
Interface OutPortConsumer

All Known Implementing Classes:

OutPortCorbaCdrConsumer

public interface OutPortConsumer

出力ポートコンシューマが提供すべき機能のインタフェースです。

Method Summary

ReturnCode	get(org.omg.CORBA.portable.OutputStream data) Pure virtual function to receive data.
void	init(Properties prop) Initializing configuration
void	setBuffer(BufferBase<org.omg.CORBA.portable.OutputStream> buffer) Setting outside buffer's pointer
void	setConnector(InPortConnector connector) setting Connector
void	setListener(ConnectorBase.ConnectorInfo info, ConnectorListeners listeners)
boolean	subscribeInterface(NVListHolder properties) 指定されたプロパティセットの内容に基づいて、データ受信通知の受け取りに登録します。
void	unsubscribeInterface(NVListHolder properties) データ受信通知の受け取り登録を解除します。

Method Detail

subscribeInterface

boolean subscribeInterface(NVListHolder properties)

指定されたプロパティセットの内容に基づいて、データ受信通知の受け取りに登録します。

Parameters:

properties - 登録時に参照される情報

Returns:

登録された場合にはtrueを、さもなくばfalseを返します。

unsubscribeInterface

void unsubscribeInterface(NVListHolder properties)

データ受信通知の受け取り登録を解除します。

Parameters:

properties - 登録解除時に参照される情報

init

void init(Properties prop)

Initializing configuration

This operation would be called to configure in initialization. In the concrete class, configuration should be performed getting appropriate information from the given Properties data. This function might be called right after instantiation and connection sequence respectivly. Therefore, this function should be implemented assuming multiple call.

Parameters:

prop - Configuration information

setBuffer

void setBuffer(BufferBase<org.omg.CORBA.portable.OutputStream> buffer)

Setting outside buffer's pointer

A pointer to a buffer from which OutPortProvider retrieve data. If already buffer is set, previous buffer's pointer will be overwritten by the given pointer to a buffer. Since OutPortProvider does not assume ownership of the buffer pointer, destructor of the buffer should be done by user.

Parameters:

buffer - A pointer to a data buffer to be used by OutPortProvider

get

ReturnCode get(org.omg.CORBA.portable.OutputStream data)

Pure virtual function to receive data.

Parameters:

data -

Returns:

PORT_OK BUFFER_TIMEOUT RECV_EMPTY CONNECTION_LOST PORT_ERROR UNKNOWN_ERROR

setConnector

void setConnector(InPortConnector connector)

setting Connector

Parameters:

connector -

setListener

void setListener(ConnectorBase.ConnectorInfo info,
                 ConnectorListeners listeners)