ufm::io::InputStream 結構 參考文件

[Interface] 定義了輸入流的基本操作 更多...

#include <InputStream.h>

類別ufm::io::InputStream的繼承圖:

公開方法(Public Methods)
virtual bool	abortRead (void) override
	中止讀取操作。
virtual bool	readBusy (void) override
	檢查讀取操作是否忙碌。
virtual bool	read (ufm::lang::Appendable &appendable, void *attachment, ufm::io::CompletionHandler< int > *handler) override
	非同步讀取。從輸入串流中讀取一些字節數，並將他們存到寫入緩衝區writeBuffer。
bool	read (ufm::lang::Appendable &appendable, ufm::util::Future< int > &future)
	同步讀取。從輸入串流中讀取一些字節數，並將他們存到寫入緩衝區appendable。

詳細描述

[Interface] 定義了輸入流的基本操作

自

1.0.0

函式成員說明文件

abortRead()

virtual bool ufm::io::InputStream::abortRead ( void )

pure virtual

中止讀取操作。

傳回值

true 成功中止讀取。

false 中止讀取失敗。

實作於 ufm::io::SerialPort::InputStream, 及 ufm::io::SimpleInputStream.

read() [1/2]

bool ufm::io::InputStream::read ( ufm::lang::Appendable & appendable, ufm::util::Future< int > & future )

inline

同步讀取。從輸入串流中讀取一些字節數，並將他們存到寫入緩衝區appendable。

參數

appendable	寫緩衝區。
future	用於表示操作狀態的Future對象。

傳回值

true 建立同步讀取成功。

false 建立同步讀取失敗，輸入串流正在忙碌。

read() [2/2]

virtual bool ufm::io::InputStream::read ( ufm::lang::Appendable & appendable, void * attachment, ufm::io::CompletionHandler< int > * handler )

pure virtual

非同步讀取。從輸入串流中讀取一些字節數，並將他們存到寫入緩衝區writeBuffer。

當寫緩衝區滿時將調用handler進行非同步事件。

tips. 此方法調用後不論狀態將立即返回。

參數

writeBuffer	寫緩衝區。
attachment	使用者參數，將再調用handler時傳入。
handler	事件處理器。

傳回值

true 建立非同步讀取成功。

false 建立非同步讀取失敗，輸入串流正在忙碌。

實作於 ufm::io::SerialPort::InputStream, 及 ufm::io::SimpleInputStream.

readBusy()

virtual bool ufm::io::InputStream::readBusy ( void )

pure virtual

檢查讀取操作是否忙碌。

傳回值

true 讀取操作忙碌。

false 讀取操作不忙碌。

實作於 ufm::io::SimpleInputStream.

---

此結構(structure) 文件是由下列檔案中產生:

• InputStream.h