mframe::lang::Readable 結構 參考文件

類別mframe::lang::Readable的繼承圖:

公開方法(Public Methods)
virtual int	avariable (void) const override
	取得輸出緩存內剩餘多少位元組
virtual int	pollByte (char &result) override
	檢索一個字節，並由此緩衝區刪除
virtual int	poll (mframe::lang::Appendable &appendable) override
	檢索至Appendable指定數量字節，並由此緩衝區刪除
virtual int	poll (void *pointer, int length) override
	檢索至pointer指定數量字節，並由此緩衝區刪除
virtual int	skip (int length) override
	跳躍指定的字結數量，並由此緩衝區刪除。
virtual void	lock (bool enable) override
	鎖定緩存，取出不移除。
bool	isEmpty (void) const
	輸出緩存是否為空?
int	poll (mframe::lang::Appendable &&appendable)
	檢索至Appendable，並由此緩衝區刪除
公開方法(Public Methods) 繼承自 mframe::lang::Interface
virtual	~Interface (void)=default
	Destroy the struct object.
virtual mframe::lang::Object &	getObject (void) override
	取得類Object

函式成員說明文件

avariable()

virtual int mframe::lang::Readable::avariable ( void ) const

pure virtual

取得輸出緩存內剩餘多少位元組

傳回值

int 緩存內有效位元組數量

實作於 mframe::io::ByteBuffer, mframe::io::RingBuffer, 及 mframe::io::SimpleReader.

isEmpty()

bool mframe::lang::Readable::isEmpty ( void ) const

inline

輸出緩存是否為空?

傳回值

true 輸出緩存為空

false 輸出緩存不為空

lock()

virtual void mframe::lang::Readable::lock ( bool enable )

pure virtual

鎖定緩存，取出不移除。

參數

enable

啟用

實作於 mframe::io::ByteBuffer, 及 mframe::io::RingBuffer.

poll() [1/3]

int mframe::lang::Readable::poll ( mframe::lang::Appendable && appendable )

inline

檢索至Appendable，並由此緩衝區刪除

參數

appendable

輸出緩衝區

傳回值

int 檢索的位元組數量

poll() [2/3]

virtual int mframe::lang::Readable::poll ( mframe::lang::Appendable & appendable )

pure virtual

檢索至Appendable指定數量字節，並由此緩衝區刪除

參數

appendable

輸出緩衝區

傳回值

int 檢索的位元組數量

實作於 mframe::io::ByteBuffer, mframe::io::RingBuffer, 及 mframe::io::SimpleReader.

poll() [3/3]

virtual int mframe::lang::Readable::poll ( void * pointer, int length )

pure virtual

檢索至pointer指定數量字節，並由此緩衝區刪除

參數

pointer	資料來源指針
length	資料長度

傳回值

int 實際檢索的位元組數量

實作於 mframe::io::ByteBuffer, mframe::io::RingBuffer, 及 mframe::io::SimpleReader.

pollByte()

virtual int mframe::lang::Readable::pollByte ( char & result )

pure virtual

檢索一個字節，並由此緩衝區刪除

參數

result

傳回值

int 緩衝區剩餘可讀取數量

實作於 mframe::io::ByteBuffer, mframe::io::RingBuffer, 及 mframe::io::SimpleReader.

skip()

virtual int mframe::lang::Readable::skip ( int length )

pure virtual

跳躍指定的字結數量，並由此緩衝區刪除。

參數

length

指定跳躍的字節數量。

傳回值

int 實際跳躍的字節數量。

實作於 mframe::io::ByteBuffer, mframe::io::RingBuffer, 及 mframe::io::SimpleReader.

---

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

• Readable.h