ZeusBase-Library  2.0.4
Public Member Functions | List of all members
zeus::IOutputStream Class Referenceabstract

#include <IOutputStream.hpp>

Inheritance diagram for zeus::IOutputStream:
zeus::IZUnknown zeus::TAbstractOutputStream zeus::TBluetoothSocket zeus::TSerialConnection zeus::TSocket zeus::TByteArrayOutputStream zeus::TFileOutputStream zeus::TFilterOutputStream zeus::TBase64OutputStream zeus::TCryptedOutputStream zeus::TTextOutputStream zeus::TZippedOutputStream

Public Member Functions

virtual Retval MQUALIFIER write (const char *pBuffer, Int iBufferSize)=0
 
virtual Retval MQUALIFIER writeInt8 (Int8 cData)=0
 
virtual Retval MQUALIFIER writeInt16 (Int16 sData)=0
 
virtual Retval MQUALIFIER writeInt32 (Int32 lData)=0
 
virtual Retval MQUALIFIER writeInt64 (const Int64 &rldData)=0
 
virtual Retval MQUALIFIER writeUint8 (Uint8 ucData)=0
 
virtual Retval MQUALIFIER writeUint16 (Uint16 usData)=0
 
virtual Retval MQUALIFIER writeUint32 (Uint32 ulData)=0
 
virtual Retval MQUALIFIER writeUint64 (const Uint64 &ruldData)=0
 
virtual Retval MQUALIFIER writeFloat32 (Float32 fData)=0
 
virtual Retval MQUALIFIER writeFloat64 (const Float64 &rdData)=0
 
virtual Retval MQUALIFIER writeBool (bool bData)=0
 
virtual Retval MQUALIFIER writeArray (const IByteArray &rData)=0
 
virtual Retval MQUALIFIER writeString (const IString &rData)=0
 
virtual void MQUALIFIER close ()=0
 
virtual void MQUALIFIER flush ()=0
 
- Public Member Functions inherited from zeus::IZUnknown
virtual Retval MQUALIFIER askForInterface (const InterfaceID &rInterfaceID, IZUnknown *&rpIface)=0
 
virtual void MQUALIFIER addRef () const =0
 
virtual void MQUALIFIER release () const =0
 

Detailed Description

Interface is defining a output stream

Member Function Documentation

§ close()

virtual void MQUALIFIER zeus::IOutputStream::close ( )
pure virtual

Closes the output stream

Implemented in zeus::TSerialConnection, zeus::TAbstractOutputStream, zeus::TBluetoothSocket, zeus::TSocket, zeus::TByteArrayOutputStream, zeus::TZippedOutputStream, zeus::TFileOutputStream, and zeus::TFilterOutputStream.

§ flush()

virtual void MQUALIFIER zeus::IOutputStream::flush ( )
pure virtual

Flush the output stream. This will send the buffer to the destination.

Implemented in zeus::TSerialConnection, zeus::TBluetoothSocket, zeus::TAbstractOutputStream, zeus::TSocket, zeus::TTextOutputStream, zeus::TByteArrayOutputStream, zeus::TBase64OutputStream, zeus::TZippedOutputStream, zeus::TFileOutputStream, zeus::TFilterOutputStream, and zeus::TCryptedOutputStream.

§ write()

virtual Retval MQUALIFIER zeus::IOutputStream::write ( const char *  pBuffer,
Int  iBufferSize 
)
pure virtual

Writes to a stream out of a buffer

Parameters
pBuffer: Char Array
iBufferSize: Size of the Array
Return values
RET_NOERROR: Writing was successful
RET_REQUEST_FAILED: Could not write to stream

Implemented in zeus::TSerialConnection, zeus::TAbstractOutputStream, zeus::TBluetoothSocket, zeus::TSocket, zeus::TTextOutputStream, zeus::TByteArrayOutputStream, zeus::TBase64OutputStream, zeus::TZippedOutputStream, zeus::TFileOutputStream, zeus::TCryptedOutputStream, and zeus::TFilterOutputStream.

§ writeArray()

virtual Retval MQUALIFIER zeus::IOutputStream::writeArray ( const IByteArray &  rData)
pure virtual

Writes a byte array to a stream. This method uses some simple encoding. First 4 Byytes are used to write the array size, then the 8Bit array will be written into the output stream. [4][3][2][1] = size, [0][1]..[size]. Use the readArray() method to read the array correctly from a stream.

Parameters
rData: Byte Array
Return values
RET_NOERROR: Writing was successful
RET_REQUEST_FAILED: Could not write to stream

Implemented in zeus::TSerialConnection, zeus::TAbstractOutputStream, zeus::TBluetoothSocket, zeus::TSocket, and zeus::TTextOutputStream.

§ writeBool()

virtual Retval MQUALIFIER zeus::IOutputStream::writeBool ( bool  bData)
pure virtual

Writes a long value to a stream

Parameters
bData: Long value
Return values
RET_NOERROR: Writing was successful
RET_REQUEST_FAILED: Could not write to stream

Implemented in zeus::TSerialConnection, zeus::TAbstractOutputStream, zeus::TBluetoothSocket, zeus::TSocket, and zeus::TTextOutputStream.

§ writeFloat32()

virtual Retval MQUALIFIER zeus::IOutputStream::writeFloat32 ( Float32  fData)
pure virtual

Writes a float32 value to a stream

Parameters
fData: float32 value
Return values
RET_NOERROR: Writing was successful
RET_REQUEST_FAILED: Could not write to stream

Implemented in zeus::TSerialConnection, zeus::TAbstractOutputStream, zeus::TBluetoothSocket, zeus::TSocket, and zeus::TTextOutputStream.

§ writeFloat64()

virtual Retval MQUALIFIER zeus::IOutputStream::writeFloat64 ( const Float64 &  rdData)
pure virtual

Writes a float64 value to a stream

Parameters
rdData: float64 value
Return values
RET_NOERROR: Writing was successful
RET_REQUEST_FAILED: Could not write to stream

Implemented in zeus::TSerialConnection, zeus::TAbstractOutputStream, zeus::TBluetoothSocket, zeus::TSocket, and zeus::TTextOutputStream.

§ writeInt16()

virtual Retval MQUALIFIER zeus::IOutputStream::writeInt16 ( Int16  sData)
pure virtual

Writes an int16 value to a stream

Parameters
sData: int16 value
Return values
RET_NOERROR: Writing was successful
RET_REQUEST_FAILED: Could not write to stream

Implemented in zeus::TSerialConnection, zeus::TAbstractOutputStream, zeus::TBluetoothSocket, zeus::TSocket, and zeus::TTextOutputStream.

§ writeInt32()

virtual Retval MQUALIFIER zeus::IOutputStream::writeInt32 ( Int32  lData)
pure virtual

Writes an int32 value to a stream

Parameters
lData: int32 value
Return values
RET_NOERROR: Writing was successful
RET_REQUEST_FAILED: Could not write to stream

Implemented in zeus::TSerialConnection, zeus::TAbstractOutputStream, zeus::TBluetoothSocket, zeus::TSocket, and zeus::TTextOutputStream.

§ writeInt64()

virtual Retval MQUALIFIER zeus::IOutputStream::writeInt64 ( const Int64 &  rldData)
pure virtual

Writes an int64 value to a stream

Parameters
rldData: int64 value
Return values
RET_NOERROR: Writing was successful
RET_REQUEST_FAILED: Could not write to stream

Implemented in zeus::TSerialConnection, zeus::TAbstractOutputStream, zeus::TBluetoothSocket, zeus::TSocket, and zeus::TTextOutputStream.

§ writeInt8()

virtual Retval MQUALIFIER zeus::IOutputStream::writeInt8 ( Int8  cData)
pure virtual

Writes an int8 value to a stream

Parameters
cData: int8 value
Return values
RET_NOERROR: Writing was successful
RET_REQUEST_FAILED: Could not write to stream

Implemented in zeus::TSerialConnection, zeus::TAbstractOutputStream, zeus::TBluetoothSocket, zeus::TSocket, zeus::TTextOutputStream, zeus::TByteArrayOutputStream, zeus::TBase64OutputStream, zeus::TZippedOutputStream, zeus::TFileOutputStream, zeus::TCryptedOutputStream, and zeus::TFilterOutputStream.

§ writeString()

virtual Retval MQUALIFIER zeus::IOutputStream::writeString ( const IString &  rData)
pure virtual

Writes a string to a stream (16bit only). This method uses some simple encoding. First 4 Bytes are used to write the string size. Then the 16 bit string will be written into the output stream. [4][3][2][1] = size, [0_h][0_l][1_h][1_l]..[size_h][size_l]. Use readString() method to read the correct string data. Note that this method is able to handle unicode.

Parameters
rData: String value
Return values
RET_NOERROR: Writing was successful
RET_REQUEST_FAILED: Could not write to stream

Implemented in zeus::TSerialConnection, zeus::TAbstractOutputStream, zeus::TBluetoothSocket, zeus::TSocket, and zeus::TTextOutputStream.

§ writeUint16()

virtual Retval MQUALIFIER zeus::IOutputStream::writeUint16 ( Uint16  usData)
pure virtual

Writes an unsigned int16 value to a stream

Parameters
usData: int16 value
Return values
RET_NOERROR: Writing was successful
RET_REQUEST_FAILED: Could not write to stream

Implemented in zeus::TSerialConnection, zeus::TAbstractOutputStream, zeus::TBluetoothSocket, zeus::TSocket, and zeus::TTextOutputStream.

§ writeUint32()

virtual Retval MQUALIFIER zeus::IOutputStream::writeUint32 ( Uint32  ulData)
pure virtual

Writes an unsigned int32 value to a stream

Parameters
ulData: int32 value
Return values
RET_NOERROR: Writing was successful
RET_REQUEST_FAILED: Could not write to stream

Implemented in zeus::TSerialConnection, zeus::TAbstractOutputStream, zeus::TBluetoothSocket, zeus::TSocket, and zeus::TTextOutputStream.

§ writeUint64()

virtual Retval MQUALIFIER zeus::IOutputStream::writeUint64 ( const Uint64 &  ruldData)
pure virtual

Writes an unsigned int64 value to a stream

Parameters
ruldData: int64 value
Return values
RET_NOERROR: Writing was successful
RET_REQUEST_FAILED: Could not write to stream

Implemented in zeus::TSerialConnection, zeus::TAbstractOutputStream, zeus::TBluetoothSocket, zeus::TSocket, and zeus::TTextOutputStream.

§ writeUint8()

virtual Retval MQUALIFIER zeus::IOutputStream::writeUint8 ( Uint8  ucData)
pure virtual

Writes an unsigned int8 value to a stream

Parameters
ucData: int8 value
Return values
RET_NOERROR: Writing was successful
RET_REQUEST_FAILED: Could not write to stream

Implemented in zeus::TSerialConnection, zeus::TAbstractOutputStream, zeus::TBluetoothSocket, and zeus::TSocket.

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

Written by Benjamin Hadorn http://www.xatlantis.ch.
Last change made on Tue Sep 13 2016 22:31:36