LocalSocketConnection Class Reference

#include <localsocketconnection.h>

Inheritance diagram for LocalSocketConnection:

Public Member Functions
	LocalSocketConnection (QObject *parentObject, QLocalSocket *socket)
	LocalSocketConnection (QObject *parentObject, const QString &connectionString)
	~LocalSocketConnection ()
void	open ()
void	start ()
void	close ()
bool	isOpen ()
QString	connectionString () const
bool	send (const PacketType &packet, const EndpointIdType &endpoint)
void	flush ()
Public Member Functions inherited from Connection
	Connection (QObject *parentObject=0)

Additional Inherited Members
Signals inherited from Connection
void	packetReceived (const MoleQueue::PacketType &packet, const MoleQueue::EndpointIdType &endpoint)
void	disconnected ()

Detailed Description

Provides am implementation of @Connection using QLocalSockets. Each instance of the class wraps a QLocalSocket.

<molequeue/servervcore/localsocketconnection.h>

Constructor & Destructor Documentation

LocalSocketConnection() [1/2]

LocalSocketConnection ( QObject * parentObject, QLocalSocket * socket )

explicit

Constructor used by @LocalSocketConnectionListener to create a new connection based on an existing QLocalSocket.

Parameters

parentObject	parent
socket	The socket that this connection instance will operate on.

LocalSocketConnection() [2/2]

LocalSocketConnection ( QObject * parentObject, const QString & connectionString )

explicit

Constructor used by a client to connection to a server ( @ConnectionListener )

Parameters

parentObject	parent
connectionString	The "address" of server to connect to.

~LocalSocketConnection()

~LocalSocketConnection

(

)

Destructor.

Member Function Documentation

open()

void open ( )

virtual

Opens the connection the server i.e. QLocalSocket::connectToServer(...)

See also

Connection::open()

Implements Connection.

start()

void start ( )

virtual

Start receiving messages on this connection.

See also

Connection::start

Implements Connection.

close()

void close ( )

virtual

Close the underlying socket. Once closed the connection can no longer be used to receive or send messages.

See also

Connection::close()

Implements Connection.

isOpen()

bool isOpen ( )

virtual

Returns

true is connection is open, false otherwise.

See also

Connection::isOpen()

Implements Connection.

connectionString()

QString connectionString ( ) const

virtual

Returns

The serverName from the underlying socket.

See also

Connection::connectionString()

Implements Connection.

send()

bool send ( const PacketType & packet, const EndpointIdType & endpoint )

virtual

Send the packet on the connection to endpoint.

Implements Connection.

flush()

void flush ( )

virtual

Flush all pending messages to the other endpoint.

Implements Connection.

---

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

• localsocketconnection.h