Class RSyncMLTransport

class RSyncMLTransport : public RSubSessionBase;

Description

Handle to information about an available SyncML transport.

Derivation

• RSubSessionBase - Client-side handle to a sub-session.

• RSyncMLTransport - Handle to information about an available SyncML transport.

Members

Defined in RSyncMLTransport:

• Close()Closes this handle.
• DisplayName()constGets the human-readable display name of the transport referenced by this handle.
• Identifier()constGets the ID of the transport referenced by this handle.
• OpenL(RSyncMLSession &,TSmlTransportId)Opens a handle on the transport identified by aId.
• Properties()constGets a list of all properties supported by this transport.
• RSyncMLTransport()Default constructor.
• StartListeningL()constStarts listening for incoming connections on this transport.
• StopListeningL()constStops listening for incoming connections on this transport.
• SupportsCapability(TSmlTransportCap)constTests if the specified capability is supported.

Inherited from RSubSessionBase:

• CloseSubSession(TInt)Closes the sub-session.
• CreateAutoCloseSubSession(RSessionBase &,TInt,const TIpcArgs &)Creates a new sub-session within an existing session. The new sub-session takes ...
• CreateSubSession(const RSessionBase &,TInt)Creates a new sub-session within an existing session.
• CreateSubSession(const RSessionBase &,TInt,const TIpcArgs &)Creates a new sub-session within an existing session.
• Send(TInt)constSends a blind message to the server - no reply is expected.
• Send(TInt,const TIpcArgs &)constSends a blind message to the server - no reply is expected.
• SendReceive(TInt)constSends a message to the server and waits synchronously for a reply.
• SendReceive(TInt,TRequestStatus &)constSends a message to the server and waits asynchronously for the reply.
• SendReceive(TInt,const TIpcArgs &)constSends a message to the server and waits synchronously for a reply.
• SendReceive(TInt,const TIpcArgs &,TRequestStatus &)constSends a message to the server and waits asynchronously for the reply.
• Session()constReturns a copy of the session associated with this sub-session.
• SubSessionHandle()constGets the sub-session handle number.

IMPORT_C RSyncMLTransport();

Description

Default constructor.

IMPORT_C void OpenL(RSyncMLSession &, TSmlTransportId);

Description

Opens a handle on the transport identified by aId.

Parameters

RSyncMLSession & An open session with the Sync Agent. TSmlTransportId The ID of the transport to open.

Leave codes

SyncMLError::KErrTransportNotFound The specified transport ID does not represent a valid transport. KErrNoMemory Insufficient system memory to complete the operation. System error codes.

IMPORT_C TSmlTransportId Identifier() const;

Pre-Condition

The handle is open.

Description

Gets the ID of the transport referenced by this handle.

Return value

TSmlTransportId The transport ID.

IMPORT_C const TDesC& DisplayName() const;

Pre-Condition

The handle is open.

Description

Gets the human-readable display name of the transport referenced by this handle.

Return value

const TDesC16 & The name of the transport.

IMPORT_C TBool SupportsCapability(TSmlTransportCap) const;

Pre-Condition

The handle is open.

Description

Tests if the specified capability is supported.

Parameters

TSmlTransportCap The capability to test support for.

Return value

TBool True if the specified capability is supported.

IMPORT_C const CSyncMLTransportPropertiesArray& Properties() const;

Pre-Condition

The handle is open.

Description

Gets a list of all properties supported by this transport.

Return value

const CSyncMLTransportPropertiesArray &

Capability:

LocalServices

IMPORT_C void StartListeningL() const;

Pre-Condition

The handle is open.

Description

Starts listening for incoming connections on this transport.

Post-Condition

The transport is listening for incoming connections.

Leave codes

KErrNoMemory Insufficient system memory to complete the operation. System error codes.

Capability:

LocalServices

IMPORT_C void StopListeningL() const;

Pre-Condition

The handle is open.

The transport is listening for incoming connections.

Description

Stops listening for incoming connections on this transport.

Post-Condition

The transport is NOT listening for incoming connections.

Leave codes

KErrNoMemory Insufficient system memory to complete the operation. System error codes.

IMPORT_C void Close();

Description

Closes this handle.