Qt Extended Home · Index · Classes · Headers · Overviews

QDLinkPlugin Class Reference

The QDLinkPlugin class is responsible for maintaining a network link. More...

    #include <QDLinkPlugin>

Inherits QDPlugin.

• List of all members, including inherited members

Public Types

• enum State { Up, Down }

Public Functions

• QDLinkPlugin ( QObject * parent = 0 )
• virtual ~QDLinkPlugin ()
• virtual int ping_interval ()
• virtual bool send_ack ()
• QIODevice * socket ()
• virtual void stop () = 0
• virtual bool tryConnect ( QDConPlugin * connection ) = 0

• 7 public functions inherited from QDPlugin
• 29 public functions inherited from QObject

Signals

• void setState ( QDLinkPlugin * plugin, int state )

• 1 signal inherited from QObject

Protected Functions

• void setupSocket ( QIODevice * device )

• 7 protected functions inherited from QObject

Additional Inherited Members

• 1 property inherited from QObject
• 1 public slot inherited from QObject
• 1 public type inherited from QObject
• 4 static public members inherited from QObject
• 2 protected variables inherited from QObject

Detailed Description

The QDLinkPlugin class is responsible for maintaining a network link.

This plugin should be used to bring up a network interface and provide an IP address for Qt Extended Sync Agent to connect to.

Member Type Documentation

enum QDLinkPlugin::State

This enum type specifies the state of the connection.

Member Function Documentation

QDLinkPlugin::QDLinkPlugin ( QObject * parent = 0 )

Construct a QDLinkPlugin with parent as the owning QObject.

QDLinkPlugin::~QDLinkPlugin ()   [virtual]

Destructor.

int QDLinkPlugin::ping_interval ()   [virtual]

Returns the time in miliseconds between pings. Returning 0 will disable the pings, relying on the underlying connection to correctly indicate loss of connection.

Note that this value can be overridden by the user when operating in debug mode.

bool QDLinkPlugin::send_ack ()   [virtual]

Returns true if HELPER_ACK commands should be sent, false otherwise.

void QDLinkPlugin::setState ( QDLinkPlugin * plugin, int state )   [signal]

This signal should be emitted by the plugin to indicate changes in state using a constant from the QDLinkPlugin::State enum.

void QDLinkPlugin::setupSocket ( QIODevice * device )   [protected]

Call this function after you have created your device to initialize the socket. Note that the device will be moved to a separate thread so you should not interact with it except via signals. For the proxy device that you can interact with see QDLinkPlugin::socket().

Ownership of device is taken by QDLinkPlugin and it will be destroyed when the plugin is destroyed but you can delete it yourself using the QObject::deleteLater() function.

QIODevice * QDLinkPlugin::socket ()

Returns the socket for connections to use or 0 if the socket has not been initialized.

void QDLinkPlugin::stop ()   [pure virtual]

Tear down the link. The socket() function should return 0 once this function has been called.

bool QDLinkPlugin::tryConnect ( QDConPlugin * connection )   [pure virtual]

Attempt to bring up the link, using the port from connection (for TCP/IP-based links). Return false to indicate immediate failure and the setState() signal to indicate asynchronous failure.