xTitan
 All Classes Functions Groups
Classes | Public Types | Signals | Public Member Functions | Friends | List of all members
xtitan::SimpleSocket Class Reference

A simple network client. More...

Inheritance diagram for xtitan::SimpleSocket:

Classes

class  Private
 

Public Types

typedef QPair< QString, QVariant > Packet
 

Signals

void connected ()
 
void disconnected ()
 
void error (QLocalSocket::LocalSocketError socketError)
 
void readyRead ()
 
void stateChanged (QLocalSocket::LocalSocketState socketState)
 

Public Member Functions

 SimpleSocket (QObject *parent=0)
 constructor More...
 
void abort ()
 abort connection More...
 
bool atEnd () const
 check if no pending data More...
 
void close ()
 close connection More...
 
void connectToServer (const QString &name, QIODevice::OpenMode openMode=QIODevice::ReadWrite)
 connect to a server More...
 
Q_INVOKABLE void disconnectFromServer ()
 disconnect from server
 
QLocalSocket::LocalSocketError error () const
 get last error code More...
 
QString errorString () const
 get last error message More...
 
bool flush ()
 flush pending socket More...
 
QString fullServerName () const
 get full server name More...
 
bool isValid () const
 check socket state More...
 
QString serverName () const
 get short server name More...
 
QLocalSocket::LocalSocketState state () const
 get socket state More...
 
Packet read ()
 read one data More...
 
bool waitForReadyRead (int msecs=30000)
 block until read something More...
 
Q_INVOKABLE void write (const QString &command, const QVariant &data) const
 send packet More...
 

Friends

class SimpleServer
 

Detailed Description

A simple network client.

Constructor & Destructor Documentation

SimpleSocket::SimpleSocket ( QObject *  parent = 0)
explicit

constructor

Parameters
[in]parentparent of this QObject

Member Function Documentation

void SimpleSocket::abort ( )

abort connection

See Also
close()
bool SimpleSocket::atEnd ( ) const

check if no pending data

Returns
true if no pending data
void SimpleSocket::close ( )

close connection

See Also
abort()
void SimpleSocket::connectToServer ( const QString &  name,
QIODevice::OpenMode  openMode = QIODevice::ReadWrite 
)

connect to a server

Parameters
[in]nameserver name
[in]openModeread or write
QLocalSocket::LocalSocketError SimpleSocket::error ( ) const

get last error code

Returns
last error code
QString SimpleSocket::errorString ( ) const

get last error message

Returns
last error message
bool SimpleSocket::flush ( )

flush pending socket

Returns
true if data flushed
QString SimpleSocket::fullServerName ( ) const

get full server name

Returns
full server name
bool SimpleSocket::isValid ( ) const

check socket state

Returns
true if socket is still connecting
SimpleSocket::Packet SimpleSocket::read ( )

read one data

Returns
a packet
QString SimpleSocket::serverName ( ) const

get short server name

Returns
short server name
QLocalSocket::LocalSocketState SimpleSocket::state ( ) const

get socket state

Returns
current socket state
bool SimpleSocket::waitForReadyRead ( int  msecs = 30000)

block until read something

Returns
true if read something and not timeout
void SimpleSocket::write ( const QString &  header,
const QVariant &  data 
) const

send packet

Parameters
[in]headerpacket header
[in]datapacket data

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