Browse Subversion Repository
Contents of /connection/ConnectionInterface.h
 Parent Directory
|  Revision Log
Revision 373 -
( show annotations)
( download)
( as text)
Tue Dec 9 11:32:24 2008 UTC
(15 years, 5 months ago)
by satofumi
File MIME type: text/x-chdr
File size: 2091 byte(s)
urg.lib がコンパイルできるように調整
| 1 |
#ifndef CONNECTION_INTERFACE_H |
| 2 |
#define CONNECTION_INTERFACE_H |
| 3 |
|
| 4 |
/*! |
| 5 |
\file |
| 6 |
\brief 通信デバイスのインターフェース定義 |
| 7 |
|
| 8 |
\author Satofumi KAMIMURA |
| 9 |
|
| 10 |
$Id$ |
| 11 |
*/ |
| 12 |
|
| 13 |
|
| 14 |
namespace beego { |
| 15 |
/*! |
| 16 |
\brief 通信インターフェース |
| 17 |
*/ |
| 18 |
class ConnectionInterface { |
| 19 |
public: |
| 20 |
virtual ~ConnectionInterface(void) {} |
| 21 |
|
| 22 |
/*! |
| 23 |
\brief 内部状態を返す |
| 24 |
|
| 25 |
\return 内部状態を示す文字列 |
| 26 |
*/ |
| 27 |
virtual const char* what(void) = 0; |
| 28 |
|
| 29 |
/*! |
| 30 |
\brief デバイスへの接続 |
| 31 |
|
| 32 |
\param device [i] 接続デバイス名 |
| 33 |
\param baudrate [i] 接続ボーレート |
| 34 |
|
| 35 |
\retval true 成功 |
| 36 |
\retval false 失敗 |
| 37 |
*/ |
| 38 |
virtual bool connect(const char* device, long baudrate) = 0; |
| 39 |
|
| 40 |
/*! |
| 41 |
\brief 切断 |
| 42 |
*/ |
| 43 |
virtual void disconnect(void) = 0; |
| 44 |
|
| 45 |
/*! |
| 46 |
\brief 接続状態を返す |
| 47 |
|
| 48 |
\retval true 接続中 |
| 49 |
\retval false 切断中 |
| 50 |
*/ |
| 51 |
virtual bool isConnected(void) = 0; |
| 52 |
|
| 53 |
/*! |
| 54 |
\brief ボーレートの変更 |
| 55 |
|
| 56 |
\param baudrate [i] ボーレート |
| 57 |
|
| 58 |
\retval true 正常に変更 |
| 59 |
\retval false 変更に失敗 |
| 60 |
*/ |
| 61 |
virtual bool changeBaudrate(long baudrate) = 0; |
| 62 |
|
| 63 |
/*! |
| 64 |
\brief 送信 |
| 65 |
|
| 66 |
\param data [i] 送信データ |
| 67 |
\param size [i] 送信バイト数 |
| 68 |
|
| 69 |
\return 送信したバイト数 |
| 70 |
*/ |
| 71 |
virtual int send(const char* data, int size) = 0; |
| 72 |
|
| 73 |
/*! |
| 74 |
\brief 受信 |
| 75 |
|
| 76 |
\param data [o] 受信用バッファ |
| 77 |
\param size [i] 受信バッファの最大サイズ |
| 78 |
\param timeout [i] タイムアウト時間 [msec] |
| 79 |
*/ |
| 80 |
virtual int recv(char* data, int size, int timeout) = 0; |
| 81 |
|
| 82 |
/*! |
| 83 |
\brief 受信済みデータのバイト数を返す |
| 84 |
|
| 85 |
\param timeout [i] タイムアウト時間 [msec] |
| 86 |
|
| 87 |
\return 受信済みデータのバイト数 |
| 88 |
*/ |
| 89 |
virtual int size(int timeout = 0) = 0; |
| 90 |
|
| 91 |
/*! |
| 92 |
\brief 送受信データのクリア |
| 93 |
|
| 94 |
送信バッファ、受信済みデータをクリアする |
| 95 |
*/ |
| 96 |
virtual void clear(void) = 0; |
| 97 |
|
| 98 |
/*! |
| 99 |
\brief 受信データの破棄 |
| 100 |
|
| 101 |
受信データを読み捨てる |
| 102 |
|
| 103 |
\param total_timeout [i] 受信トータルのタイムアウト時間 [msec] |
| 104 |
*/ |
| 105 |
virtual void skip(int total_timeout) = 0; |
| 106 |
|
| 107 |
virtual void flush(void) = 0; |
| 108 |
}; |
| 109 |
}; |
| 110 |
|
| 111 |
#endif /* !CONNECTION_INTERFACE_H */ |
| 
Parent Directory
Revision Log