hrk::mConnection Class Reference

モニタ用の接続インターフェース More...

#include <mConnection.h>

Inheritance diagram for hrk::mConnection:

Collaboration diagram for hrk::mConnection:

Public Member Functions
	mConnection (Connection *connection)
const char *	what () const
	状態を示すメッセージを返す More...
bool	is_open () const
	受信 More...
void	close ()
	接続を閉じる More...
bool	change_baudrate (long baudrate)
	ボーレートの変更 More...
int	write (const char *data, size_t data_size)
	データの送信 More...
int	read (char *data, size_t max_data_size, int timeout)
	データの受信 More...
void	ungetc (int ch)
	１文字だけ受信バッファに書き戻す

Additional Inherited Members
Public Types inherited from hrk::Connection
enum	{ Timeout_infinity = -1 }

Detailed Description

モニタ用の接続インターフェース

Member Function Documentation

const char * mConnection::what ( ) const

virtual

状態を示すメッセージを返す

Returns

メッセージ文字列

Implements hrk::Connection.

bool mConnection::is_open ( ) const

virtual

受信

Return values

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

Implements hrk::Stream.

void mConnection::close ( )

virtual

接続を閉じる

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

Implements hrk::Stream.

bool mConnection::change_baudrate ( long  baudrate )

virtual

ボーレートの変更

Parameters

[in]

baudrate

ボーレート [bps]

Return values

true	成功
false	エラー

Implements hrk::Connection.

int mConnection::write ( const char *  data, size_t  data_size  )

virtual

データの送信

Parameters

[in]	data	送信するデータ
[in]	data_size	送信するデータの byte 数

Return values

>=0	送信した byte 数
<0	エラー ID

Implements hrk::Stream.

int mConnection::read ( char *  data, size_t  max_data_size, int  timeout  )

virtual

データの受信

Parameters

[in]	data	受信データ用のバッファ
[in]	max_data_size	受信できるデータの最大 byte 数
[in]	timeout	受信を待つ時間 [msec]。無限に待つ場合には Timeout_infinity を指定する。

Return values

>=0	送信した byte 数
<0	エラー ID

Implements hrk::Stream.

---

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

• lib/monitor/mConnection.h
• lib/monitor/mConnection.cpp