XBee API operation library for mbed

Embed: (wiki syntax)

« Back to documentation index

ISerial Class Reference

ISerial Class Reference

Serial data interface. More...

#include <ISerial.h>

Inherited by SerialData.

Public Member Functions

virtual int readByte ()=0
 Read one byte data from the serila port.
virtual void writeByte (char data)=0
 write one byte data to the serila port.
virtual bool isOpen ()=0
 Check if the serial port is already open.
virtual void open ()=0
 Open the serila port.
virtual void close ()=0
 Close the serila port.
virtual bool peek ()=0
 Check if data is avaliable to read.

Detailed Description

Serial data interface.

Definition at line 5 of file ISerial.h.


Member Function Documentation

virtual void close (  ) [pure virtual]

Close the serila port.

Implemented in SerialData.

virtual bool isOpen (  ) [pure virtual]

Check if the serial port is already open.

Implemented in SerialData.

virtual void open (  ) [pure virtual]

Open the serila port.

Implemented in SerialData.

virtual bool peek (  ) [pure virtual]

Check if data is avaliable to read.

Implemented in SerialData.

virtual int readByte (  ) [pure virtual]

Read one byte data from the serila port.

Returns:
if success return non zero [0x00-0xFF], -1 means something is wrong

Implemented in SerialData.

virtual void writeByte ( char  data ) [pure virtual]

write one byte data to the serila port.

Parameters:
data[0x00-0xFF]

Implemented in SerialData.