Tp::PendingStreamTubeConnection Class Reference [Channel proxies]

The PendingStreamTubeConnection class represents an asynchronous operation for accepting an incoming stream tube. More...

#include <TelepathyQt4/PendingStreamTubeConnection>

Inherits Tp::PendingOperation.

List of all members.

Public Member Functions

• virtual ~PendingStreamTubeConnection ()
• SocketAddressType addressType () const
• QPair< QHostAddress, quint16 > ipAddress () const
• QString localAddress () const
• bool requiresCredentials () const
• uchar credentialByte () const

---

Detailed Description

The PendingStreamTubeConnection class represents an asynchronous operation for accepting an incoming stream tube.

See Asynchronous Object Model

---

Constructor & Destructor Documentation

Tp::PendingStreamTubeConnection::~PendingStreamTubeConnection

(

)

[virtual]

Class destructor.

---

Member Function Documentation

SocketAddressType Tp::PendingStreamTubeConnection::addressType

(

)

const

Return the type of the opened stream tube socket.

Returns:

The socket type as SocketAddressType.

See also:

localAddress(), ipAddress()

QPair< QHostAddress, quint16 > Tp::PendingStreamTubeConnection::ipAddress

(

)

const

Return the IP address/port combination of the opened stream tube socket.

This method will return a meaningful value only if the incoming stream tube was accepted as a TCP socket.

Returns:

Pair of IP address as QHostAddress and port if using a TCP socket, or an undefined value otherwise.

See also:

addressType(), localAddress()

QString Tp::PendingStreamTubeConnection::localAddress

(

)

const

Return the local address of the opened stream tube socket.

This method will return a meaningful value only if the incoming stream tube was accepted as an Unix socket.

Returns:

Unix socket address if using an Unix socket, or an undefined value otherwise.

See also:

addressType(), ipAddress()

bool Tp::PendingStreamTubeConnection::requiresCredentials

(

)

const

Return whether sending a credential byte once connecting to the socket is required.

Note that if this method returns true, one should send a SCM_CREDS or SCM_CREDENTIALS and the credentialByte() once connected. If SCM_CREDS or SCM_CREDENTIALS cannot be sent, the credentialByte() should still be sent.

Returns:

true if sending credentials is required, false otherwise.

See also:

credentialByte()

uchar Tp::PendingStreamTubeConnection::credentialByte

(

)

const

Return the credential byte to send once connecting to the socket if requiresCredentials() is true.

Returns:

The credential byte.

See also:

requiresCredentials()