ZeusBase-Library  2.0.4
Public Member Functions | Protected Member Functions | List of all members
zeus::TBluetoothSocket Class Reference

#include <BluetoothSocket.h>

Inheritance diagram for zeus::TBluetoothSocket:
zeus::TAbstractSocket zeus::IInputStream zeus::IOutputStream zeus::TZObject zeus::IZUnknown zeus::IZUnknown zeus::IZUnknown

Public Member Functions

 TBluetoothSocket ()
 
 TBluetoothSocket (TBTAddress &rAddress)
 
 TBluetoothSocket (Int iFD, SOCKADDR_BTH &rSocketAddr)
 
bool hasAuthentication () const
 
bool hasEncryption () const
 
void setAuthentication (bool bMode)
 
void setEncryption (bool bMode)
 
virtual Retval connect ()
 
virtual bool MQUALIFIER available () const
 
virtual bool MQUALIFIER isEndReached () const
 
virtual Retval MQUALIFIER read (char *pBuffer, Int iBufferSize, Int &rValidSize) const
 
virtual Int MQUALIFIER readItem () const
 
virtual Int8 MQUALIFIER readInt8 (bool *pError) const
 
virtual Int16 MQUALIFIER readInt16 (bool *pError) const
 
virtual Int32 MQUALIFIER readInt32 (bool *pError) const
 
virtual Int64 MQUALIFIER readInt64 (bool *pError) const
 
virtual Uint8 MQUALIFIER readUint8 (bool *pError) const
 
virtual Uint16 MQUALIFIER readUint16 (bool *pError) const
 
virtual Uint32 MQUALIFIER readUint32 (bool *pError) const
 
virtual Uint64 MQUALIFIER readUint64 (bool *pError) const
 
virtual Float64 MQUALIFIER readFloat64 (bool *pError) const
 
virtual Float32 MQUALIFIER readFloat32 (bool *pError) const
 
virtual bool MQUALIFIER readBool (bool *pError) const
 
virtual Retval MQUALIFIER readArray (IByteArray &rData) const
 
virtual Retval MQUALIFIER readString (IString &rstrData) const
 
virtual void MQUALIFIER close ()
 
virtual void MQUALIFIER reset ()
 
virtual bool MQUALIFIER skip (Int iBytes=1)
 
virtual Retval MQUALIFIER write (const char *pBuffer, Int iBufferSize)
 
virtual Retval MQUALIFIER writeInt8 (Int8 cData)
 
virtual Retval MQUALIFIER writeInt16 (Int16 sData)
 
virtual Retval MQUALIFIER writeInt32 (Int32 lData)
 
virtual Retval MQUALIFIER writeInt64 (const Int64 &rldData)
 
virtual Retval MQUALIFIER writeUint8 (Uint8 ucData)
 
virtual Retval MQUALIFIER writeUint16 (Uint16 usData)
 
virtual Retval MQUALIFIER writeUint32 (Uint32 ulData)
 
virtual Retval MQUALIFIER writeUint64 (const Uint64 &ruldData)
 
virtual Retval MQUALIFIER writeFloat32 (Float32 fData)
 
virtual Retval MQUALIFIER writeFloat64 (const Float64 &rdData)
 
virtual Retval MQUALIFIER writeBool (bool bData)
 
virtual Retval MQUALIFIER writeArray (const IByteArray &rData)
 
virtual Retval MQUALIFIER writeString (const IString &rData)
 
virtual void MQUALIFIER flush ()
 
virtual Retval MQUALIFIER askForInterface (const InterfaceID &rInterfaceID, IZUnknown *&rpIface)
 
virtual void MQUALIFIER addRef () const
 
virtual void MQUALIFIER release () const
 
- Public Member Functions inherited from zeus::TAbstractSocket
 TAbstractSocket (TIPAddress &rAddress)
 
 TAbstractSocket (const TString &rstrAddr, Uint uiPort)
 
 TAbstractSocket (Int iFD, struct sockaddr_in &rAddress)
 
virtual Retval disconnect ()
 
TString getAddress () const
 
TString getHostName () const
 
Uint getPort () const
 
Int getReceiveBufferSize () const
 
Int getSendBufferSize () const
 
Int getSocketDescripitor () const
 
bool isConnected () const
 
bool isBlockable () const
 
bool isReUsable () const
 
bool isValid () const
 
void setBlockable (bool bMode)
 
void setReceiveBufferSize (Int iSize)
 
void setReUsable (bool bMode)
 
void setSendBufferSize (Int iSize)
 
void setTCPBufferEnable (bool bMode)
 
- Public Member Functions inherited from zeus::TZObject
 TZObject ()
 
 TZObject (const TString &strName)
 
 TZObject (const IString &strName)
 
Uint getHash () const
 
TString toString () const
 
virtual TString getObjName () const
 
virtual void setObjName (const TString &name)
 

Protected Member Functions

virtual ~TBluetoothSocket ()
 
virtual void openSocket ()
 
- Protected Member Functions inherited from zeus::TAbstractSocket
 TAbstractSocket ()
 
virtual ~TAbstractSocket ()
 
- Protected Member Functions inherited from zeus::TZObject
virtual ~TZObject ()
 
 TZObject (const TZObject &rObject)
 
TZObject & operator= (const TZObject &rObject)
 
Int getRefCounter () const
 

Additional Inherited Members

- Static Protected Member Functions inherited from zeus::TAbstractSocket
static Retval getErrorCode (bool bHandleBlockedAsError)
 
static bool getBoolSocketOption (Int iFD, Int iOption, Int iLevel)
 
static Int getIntSocketOption (Int iFD, Int iOption, Int iLevel)
 
static void setBoolSocketOption (Int iFD, Int iOption, Int iLevel, bool bValue)
 
static void setIntSocketOption (Int iFD, Int iOption, Int iLevel, Int iValue)
 
- Protected Attributes inherited from zeus::TAbstractSocket
TIPAddress * m_pAddress
 Address object. More...
 
bool m_bConnected
 Connected flag. More...
 
bool m_bBlockable
 blockable flag More...
 
bool m_bReUsable
 reusable flag More...
 
Int m_iSocketFD
 File descriptor for socket. More...
 
TCriticalSection & m_rSocketLock
 Critical section to protect socket file descriptor. More...
 
- Protected Attributes inherited from zeus::TZObject
Uint m_uiID
 

Detailed Description

Implements the bluetooth socket

Constructor & Destructor Documentation

§ TBluetoothSocket() [1/3]

zeus::TBluetoothSocket::TBluetoothSocket ( )

Creates the bluetooth socket

§ TBluetoothSocket() [2/3]

zeus::TBluetoothSocket::TBluetoothSocket ( TBTAddress &  rAddress)

Creates the bluetooth socket

§ TBluetoothSocket() [3/3]

zeus::TBluetoothSocket::TBluetoothSocket ( Int  iFD,
SOCKADDR_BTH &  rSocketAddr 
)

Creates a bluetooth socket out of the file descriptor and a socket address. This method is used by the bluetooth socket server, which is listening to bluetooth devices

Parameters
iFD: file descriptor of the socket
rSocketAddr: Socket address structure

§ ~TBluetoothSocket()

zeus::TBluetoothSocket::~TBluetoothSocket ( )
protectedvirtual

Destroys the bluetooth socket

Member Function Documentation

§ addRef()

virtual void MQUALIFIER zeus::TBluetoothSocket::addRef ( ) const
virtual

This method increases the reference counter of this object. The call is const because it will not change the content of the object, since the reference counter is not an object data. This allows to handle const reference using addRef() and release().

Implements zeus::IZUnknown.

§ askForInterface()

virtual Retval MQUALIFIER zeus::TBluetoothSocket::askForInterface ( const InterfaceID &  rInterfaceID,
IZUnknown *&  rpIface 
)
virtual

This method is used to cast to different interface types. This is a secure way asking for other implemented interfaces, since C++ does not reject invalid casts.

Parameters
rInterfaceID: ID of the requested interface
rpIface: return value of the interface. The pointer contains the address of the requested interface
Return values
RET_NOERROR: Interface returned
RET_UNKNOWN_INTERFACE: Interface is not valid or not implemented

Implements zeus::IZUnknown.

§ available()

virtual bool MQUALIFIER zeus::TBluetoothSocket::available ( ) const
inlinevirtual

Returns if the input stream is available (valid).

Return values
true: stream is ok
false: invalid stream

Implements zeus::IInputStream.

§ close()

virtual void MQUALIFIER zeus::TBluetoothSocket::close ( )
inlinevirtual

Closes the input stream

Implements zeus::IInputStream.

§ connect()

Retval zeus::TBluetoothSocket::connect ( )
virtual

Connects the bluetooth socket

Implements zeus::TAbstractSocket.

§ flush()

virtual void MQUALIFIER zeus::TBluetoothSocket::flush ( )
inlinevirtual

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

Implements zeus::IOutputStream.

§ hasAuthentication()

bool zeus::TBluetoothSocket::hasAuthentication ( ) const
inline

Checks if the authentication is switched on

§ hasEncryption()

bool zeus::TBluetoothSocket::hasEncryption ( ) const
inline

Checks if the encryption is switched on

§ isEndReached()

virtual bool MQUALIFIER zeus::TBluetoothSocket::isEndReached ( ) const
inlinevirtual

This method checks if the stream is at the end. If a stream is at the end the methods readDouble(), readLong(), readByte() and readBool() should not called anymore. They will return zero. You must call this method before getting data from the stream.

Return values
true: Stream is at the end
false: Stream is not at the end

Implements zeus::IInputStream.

§ openSocket()

void zeus::TBluetoothSocket::openSocket ( )
protectedvirtual

opens the socket

Implements zeus::TAbstractSocket.

§ read()

Retval MQUALIFIER zeus::TBluetoothSocket::read ( char *  pBuffer,
Int  iBufferSize,
Int &  rValidSize 
) const
virtual
See also
IInputStream::read

Implements zeus::IInputStream.

§ readArray()

Retval MQUALIFIER zeus::TBluetoothSocket::readArray ( IByteArray &  rData) const
virtual
See also
IInputStream::readArray

Implements zeus::IInputStream.

§ readBool()

bool MQUALIFIER zeus::TBluetoothSocket::readBool ( bool *  pError) const
inlinevirtual
See also
IInputStream::readBool

Implements zeus::IInputStream.

§ readFloat32()

Float32 MQUALIFIER zeus::TBluetoothSocket::readFloat32 ( bool *  pError) const
virtual
See also
IInputStream::readFloat32

Implements zeus::IInputStream.

§ readFloat64()

Float64 MQUALIFIER zeus::TBluetoothSocket::readFloat64 ( bool *  pError) const
virtual
See also
IInputStream::readFloat64

Implements zeus::IInputStream.

§ readInt16()

Int16 MQUALIFIER zeus::TBluetoothSocket::readInt16 ( bool *  pError) const
virtual
See also
IInputStream::readInt16

Implements zeus::IInputStream.

§ readInt32()

Int32 MQUALIFIER zeus::TBluetoothSocket::readInt32 ( bool *  pError) const
virtual
See also
IInputStream::readInt32

Implements zeus::IInputStream.

§ readInt64()

Int64 MQUALIFIER zeus::TBluetoothSocket::readInt64 ( bool *  pError) const
virtual
See also
IInputStream::readInt64

Implements zeus::IInputStream.

§ readInt8()

Int8 MQUALIFIER zeus::TBluetoothSocket::readInt8 ( bool *  pError) const
virtual
See also
IInputStream::readInt8

Implements zeus::IInputStream.

§ readItem()

Int MQUALIFIER zeus::TBluetoothSocket::readItem ( ) const
virtual
See also
IInputStream::readItem

Implements zeus::IInputStream.

§ readString()

Retval MQUALIFIER zeus::TBluetoothSocket::readString ( IString &  rstrData) const
virtual
See also
IInputStream::readString

Implements zeus::IInputStream.

§ readUint16()

Uint16 MQUALIFIER zeus::TBluetoothSocket::readUint16 ( bool *  pError) const
inlinevirtual
See also
IInputStream::readUint16

Implements zeus::IInputStream.

§ readUint32()

Uint32 MQUALIFIER zeus::TBluetoothSocket::readUint32 ( bool *  pError) const
inlinevirtual
See also
IInputStream::readUint32

Implements zeus::IInputStream.

§ readUint64()

Uint64 MQUALIFIER zeus::TBluetoothSocket::readUint64 ( bool *  pError) const
inlinevirtual
See also
IInputStream::readUint64

Implements zeus::IInputStream.

§ readUint8()

Uint8 MQUALIFIER zeus::TBluetoothSocket::readUint8 ( bool *  pError) const
inlinevirtual
See also
IInputStream::readUint8

Implements zeus::IInputStream.

§ release()

virtual void MQUALIFIER zeus::TBluetoothSocket::release ( ) const
virtual

This method decreases the reference counter of this object. This call is const as well (like addRef()). The killing of an object is allowed by const method, because the content is not used any more.

Implements zeus::IZUnknown.

§ reset()

virtual void MQUALIFIER zeus::TBluetoothSocket::reset ( )
inlinevirtual

Sets the stream position back to the beginning

Implements zeus::IInputStream.

§ setAuthentication()

void zeus::TBluetoothSocket::setAuthentication ( bool  bMode)
inline

Enables or disables the authentication of the bluetooth connection

§ setEncryption()

void zeus::TBluetoothSocket::setEncryption ( bool  bMode)
inline

Enables or disables the encryption of the bluetooth connection

§ skip()

bool MQUALIFIER zeus::TBluetoothSocket::skip ( Int  iBytes = 1)
virtual
See also
IInputStream::skip

Implements zeus::IInputStream.

§ write()

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

Implements zeus::IOutputStream.

§ writeArray()

Retval MQUALIFIER zeus::TBluetoothSocket::writeArray ( const IByteArray &  rData)
virtual
See also
IOutputStream::writeArray

Implements zeus::IOutputStream.

§ writeBool()

Retval MQUALIFIER zeus::TBluetoothSocket::writeBool ( bool  bData)
inlinevirtual
See also
IOutputStream::writeBool

Implements zeus::IOutputStream.

§ writeFloat32()

Retval MQUALIFIER zeus::TBluetoothSocket::writeFloat32 ( Float32  fData)
virtual
See also
IOutputStream::writeInt32

Implements zeus::IOutputStream.

§ writeFloat64()

Retval MQUALIFIER zeus::TBluetoothSocket::writeFloat64 ( const Float64 &  rdData)
virtual
See also
IOutputStream::writeFloat64

Implements zeus::IOutputStream.

§ writeInt16()

Retval MQUALIFIER zeus::TBluetoothSocket::writeInt16 ( Int16  sData)
virtual
See also
IOutputStream::writeInt16

Implements zeus::IOutputStream.

§ writeInt32()

Retval MQUALIFIER zeus::TBluetoothSocket::writeInt32 ( Int32  lData)
virtual
See also
IOutputStream::writeInt32

Implements zeus::IOutputStream.

§ writeInt64()

Retval MQUALIFIER zeus::TBluetoothSocket::writeInt64 ( const Int64 &  rldData)
virtual
See also
IOutputStream::writeInt64

Implements zeus::IOutputStream.

§ writeInt8()

Retval MQUALIFIER zeus::TBluetoothSocket::writeInt8 ( Int8  cData)
virtual
See also
IOutputStream::writeInt8

Implements zeus::IOutputStream.

§ writeString()

Retval MQUALIFIER zeus::TBluetoothSocket::writeString ( const IString &  rData)
virtual
See also
IOutputStream::writeString

Implements zeus::IOutputStream.

§ writeUint16()

Retval MQUALIFIER zeus::TBluetoothSocket::writeUint16 ( Uint16  usData)
inlinevirtual
See also
IOutputStream::writeUint16

Implements zeus::IOutputStream.

§ writeUint32()

Retval MQUALIFIER zeus::TBluetoothSocket::writeUint32 ( Uint32  ulData)
inlinevirtual
See also
IOutputStream::writeUint32

Implements zeus::IOutputStream.

§ writeUint64()

Retval MQUALIFIER zeus::TBluetoothSocket::writeUint64 ( const Uint64 &  ruldData)
inlinevirtual
See also
IOutputStream::writeUint64

Implements zeus::IOutputStream.

§ writeUint8()

Retval MQUALIFIER zeus::TBluetoothSocket::writeUint8 ( Uint8  ucData)
inlinevirtual
See also
IOutputStream::writeUint8

Implements zeus::IOutputStream.

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

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