Class RSyncMLConnection

class RSyncMLConnection : public RSubSessionBase;

Description

Handle to data defining a connection to a remote SyncML server in the context of a profile.

Derivation

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

• RSyncMLConnection - Handle to data defining a connection to a remote SyncML server in the context of...

Members

Defined in RSyncMLConnection:

• Close()Closes this handle.
• CreateL(RSyncMLProfileBase &,TSmlTransportId)Creates a new, blank, connection in the specified profile and opens this object ...
• GetPropertyL(const TDesC8 &)constGets the value of the transport property specified.
• Identifier()constGets the ID of the connection referenced by this handle.
• IsReadOnly()constTests if the parent profile is open for read and write access.
• OpenL(RSyncMLProfileBase &,TSmlConnectionId)Opens a handle to an existing connection of the specified ID within the specifie...
• Priority()constGets the relative priority of this connection within the profile.
• Profile()constGets the ID of the parent profile of this connection.
• RSyncMLConnection()Default constructor.
• RetryCount()constGets the retry count to use with the transport connection that this handle repre...
• ServerURI()constGets the URI of the server for the transport connection that this handle represe...
• SetPriority(TUint)Sets the relative priority of this connection within the profile.
• SetPropertyL(const TDesC8 &,const TDesC8 &)Sets the value of a transport property to use with this connection.
• SetRetryCount(TUint)Sets the retry count for this connection..
• SetServerURIL(const TDesC8 &)Sets the server URI to use with this connection.
• UpdateL()Transfers any changes made to the connection data to the Sync Agent.

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 RSyncMLConnection();

Description

Default constructor.

IMPORT_C void CreateL(RSyncMLProfileBase &, TSmlTransportId);

Description

Creates a new, blank, connection in the specified profile and opens this object as a handle to it.

The parent profile must be open for read/write access. The new connection is not saved until RSyncMLProfile::UpdateL() is called on the parent profile.

Parameters

Leave codes

IMPORT_C void OpenL(RSyncMLProfileBase &, TSmlConnectionId);

Description

Opens a handle to an existing connection of the specified ID within the specified profile.

The access mode (read or read/write) is inherited from the parent profile.

Parameters

Leave codes

IMPORT_C TSmlConnectionId Identifier() const;

Pre-Condition

The handle is open.

Description

Gets the ID of the connection referenced by this handle.

Return value

IMPORT_C TSmlProfileId Profile() const;

Pre-Condition

The handle is open.

Description

Gets the ID of the parent profile of this connection.

Return value

IMPORT_C TUint Priority() const;

Pre-Condition

The handle is open.

Description

Gets the relative priority of this connection within the profile.

Return value

IMPORT_C TUint RetryCount() const;

Pre-Condition

The handle is open.

Description

Gets the retry count to use with the transport connection that this handle represents.

Return value

IMPORT_C const TDesC8& ServerURI() const;

Pre-Condition

The handle is open.

Description

Gets the URI of the server for the transport connection that this handle represents.

Return value

IMPORT_C const TDesC8& GetPropertyL(const TDesC8 &aName) const;

Pre-Condition

The handle is open.

Description

Gets the value of the transport property specified.

Parameters

Return value

Leave codes

IMPORT_C void SetPriority(TUint);

Pre-Condition

The handle is open.

Description

Sets the relative priority of this connection within the profile.

This is used to determine the default connection for the profile.

Parameters

Leave codes

IMPORT_C void SetRetryCount(TUint);

Pre-Condition

The handle is open.

Description

Sets the retry count for this connection..

Parameters

Leave codes

IMPORT_C void SetServerURIL(const TDesC8 &);

Pre-Condition

The handle is open.

Description

Sets the server URI to use with this connection.

Parameters

Leave codes

IMPORT_C void SetPropertyL(const TDesC8 &aName, const TDesC8 &aValue);

Pre-Condition

The handle is open.

Description

Sets the value of a transport property to use with this connection.

Parameters

Leave codes

IMPORT_C TBool IsReadOnly() const;

Pre-Condition

The handle is open.

Description

Tests if the parent profile is open for read and write access.

Return value

IMPORT_C void UpdateL();

Pre-Condition

The handle is open for read and write access.

Description

Transfers any changes made to the connection data to the Sync Agent.

The new data will be persisted when RSyncMLProfile::UpdateL() is called on the parent profile.

Leave codes

IMPORT_C void Close();

Description

Closes this handle.