趣味で作ってるロボット用ソフトウェア
 All Classes Files Functions Enumerations Enumerator Friends Pages
Public Member Functions | List of all members
hrk::Stream Class Referenceabstract
Inheritance diagram for hrk::Stream:
Inheritance graph
[legend]

Public Member Functions

virtual bool is_open () const =0
 受信 More...
 
virtual void close ()=0
 接続を閉じる More...
 
virtual int write (const char *data, size_t data_size)=0
 データの送信 More...
 
virtual int read (char *data, size_t max_data_size, int timeout)=0
 データの受信 More...
 

Member Function Documentation

virtual bool hrk::Stream::is_open ( ) const
pure virtual

受信

Return values
true接続中
false接続していない

Implemented in hrk::Serial, hrk::Log_recorder, hrk::Tcpip, hrk::Lms_log_reader, hrk::Urg_log_reader, hrk::Receive_recorder, hrk::Zip, hrk::File, and hrk::mConnection.

virtual void hrk::Stream::close ( )
pure virtual

接続を閉じる

接続されてないときに呼び出されたときは、何もしない。

Implemented in hrk::Serial, hrk::Log_recorder, hrk::Tcpip, hrk::Lms_log_reader, hrk::Urg_log_reader, hrk::Receive_recorder, hrk::Zip, hrk::File, and hrk::mConnection.

virtual int hrk::Stream::write ( const char *  data,
size_t  data_size 
)
pure virtual

データの送信

Parameters
[in]data送信するデータ
[in]data_size送信するデータの byte 数
Return values
>=0送信した byte 数
<0エラー ID

Implemented in hrk::Serial, hrk::Log_recorder, hrk::Tcpip, hrk::Lms_log_reader, hrk::Urg_log_reader, hrk::Receive_recorder, hrk::Zip, hrk::mConnection, and hrk::File.

virtual int hrk::Stream::read ( char *  data,
size_t  max_data_size,
int  timeout 
)
pure virtual

データの受信

Parameters
[in]data受信データ用のバッファ
[in]max_data_size受信できるデータの最大 byte 数
[in]timeout受信を待つ時間 [msec]。無限に待つ場合には Timeout_infinity を指定する。
Return values
>=0送信した byte 数
<0エラー ID

Implemented in hrk::Serial, hrk::Log_recorder, hrk::Tcpip, hrk::Lms_log_reader, hrk::Urg_log_reader, hrk::Receive_recorder, hrk::Zip, hrk::mConnection, and hrk::File.


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