Symbian^3 Application Developer Library >

MRemConTargetSelectorPluginObserver Class Reference

class MRemConTargetSelectorPluginObserver

Interface presented by RemCon down to the concrete Target Selector Plugin. This class is intended for derivation inside RemCon only.

Public Member Functions
IMPORT_C TInt GetConnections ( TSglQue < TRemConAddress > &)
IMPORT_C void IncomingCommandAddressed ( TInt )
IMPORT_C void IncomingCommandPermitted ( TBool )
IMPORT_C void IncomingNotifyAddressed ( TClientInfo *, TInt )
IMPORT_C void IncomingNotifyPermitted ( TBool )
IMPORT_C void OutgoingCommandAddressed ( TInt )
IMPORT_C void OutgoingCommandPermitted ( TBool )
IMPORT_C void OutgoingNotifyCommandAddressed (TRemConAddress *, TInt )
IMPORT_C void OutgoingNotifyCommandPermitted ( TBool )
IMPORT_C void OutgoingResponsePermitted ( TBool )
IMPORT_C void ReAddressNotifies ()
IMPORT_C TInt SetLocalAddressedClient (const TUid &, const TClientInfo &)
Private Member Functions
TInt MrctspoDoGetConnections ( TSglQue < TRemConAddress > &)
void MrctspoDoIncomingCommandAddressed ( TInt )
void MrctspoDoIncomingCommandPermitted ( TBool )
void MrctspoDoIncomingNotifyAddressed ( TClientInfo *, TInt )
void MrctspoDoIncomingNotifyPermitted ( TBool )
void MrctspoDoOutgoingCommandAddressed ( TInt )
void MrctspoDoOutgoingCommandPermitted ( TBool )
void MrctspoDoOutgoingNotifyCommandAddressed (TRemConAddress *, TInt )
void MrctspoDoOutgoingNotifyCommandPermitted ( TBool )
void MrctspoDoOutgoingResponsePermitted ( TBool )
void MrctspoDoReAddressNotifies ()
TInt MrctspoSetLocalAddressedClient (const TUid &, const TClientInfo &)

Member Functions Documentation

GetConnections(TSglQue< TRemConAddress > &)

IMPORT_C TInt GetConnections ( TSglQue < TRemConAddress > & aConnections )

Utility for TSPs. Retrieves a list of currently extant bearer-level connections in RemCon server. May be used at any time between the end of TSP construction and the beginning of TSP destruction. The TSP is responsible for cleaning up aConnections- the addresses will be on the heap.

Parameters

TSglQue < TRemConAddress > & aConnections A collection of remote addresses, representing all the currently extant connections. On entry this must be empty otherwise the server will panic.

IncomingCommandAddressed(TInt)

IMPORT_C void IncomingCommandAddressed ( TInt aError )

Called by the TSP to indicate that it has addressed the incoming command from the previous AddressIncomingCommand request.

Parameters

TInt aError The error with which the command was addressed. If other than KErrNone, the command will be dropped.

IncomingCommandPermitted(TBool)

IMPORT_C void IncomingCommandPermitted ( TBool aIsPermitted )

Called by the TSP to indicate that it has decided whether the incoming command (from the previous PermitIncomingCommand request) is permitted or not.

Parameters

TBool aIsPermitted ETrue- the send is permitted, EFalse- the send is not permitted.

IncomingNotifyAddressed(TClientInfo *, TInt)

IMPORT_C void IncomingNotifyAddressed ( TClientInfo * aClientInfo,
TInt aError
)

Called by the TSP to address the incoming notify from the previous AddressIncomingNotify request.

Parameters

TClientInfo * aClientInfo Pointer to the chosen client from the list of clients passed to the TSP in the previous AddressIncomingNotify request, or a new TClientInfo, with the correct process ID (the other fields will be ignored). In the case of the TClientInfo being chosen from the list, the ownership of the TClientInfo will be retained by RemCon server. In the case of the TClientInfo being newly created because of the TSP starting and application, RemCon Server will immediately take a copy of the TClientInfo, and the TSP will retain ownership. aClientInfo should be NULL if no client is to be addressed.
TInt aError The error with which the command was addressed. If other than KErrNone, the command will be dropped.

IncomingNotifyPermitted(TBool)

IMPORT_C void IncomingNotifyPermitted ( TBool aIsPermitted )

Called by the TSP to indicate that it has decided whether the incoming notify command (from the previous PermitIncomingNotify request) is permitted or not.

Parameters

TBool aIsPermitted ETrue- the send is permitted, EFalse- the send is not permitted.

MrctspoDoGetConnections(TSglQue< TRemConAddress > &)

TInt MrctspoDoGetConnections ( TSglQue < TRemConAddress > & aConnections ) [private, pure virtual]

GetConnections .

Parameters

TSglQue < TRemConAddress > & aConnections

MrctspoDoIncomingCommandAddressed(TInt)

void MrctspoDoIncomingCommandAddressed ( TInt aError ) [private, pure virtual]

IncomingCommandAddressed .

Parameters

TInt aError

MrctspoDoIncomingCommandPermitted(TBool)

void MrctspoDoIncomingCommandPermitted ( TBool aIsPermitted ) [private, pure virtual]

IncomingCommandPermitted .

Parameters

TBool aIsPermitted

MrctspoDoIncomingNotifyAddressed(TClientInfo *, TInt)

void MrctspoDoIncomingNotifyAddressed ( TClientInfo * aClientInfo,
TInt aError
) [private, pure virtual]

IncomingNotifyAddressed .

Parameters

TClientInfo * aClientInfo
TInt aError

MrctspoDoIncomingNotifyPermitted(TBool)

void MrctspoDoIncomingNotifyPermitted ( TBool aIsPermitted ) [private, pure virtual]

IncomingNotifyPermitted .

Parameters

TBool aIsPermitted

MrctspoDoOutgoingCommandAddressed(TInt)

void MrctspoDoOutgoingCommandAddressed ( TInt aError ) [private, pure virtual]

OutgoingCommandAddressed .

Parameters

TInt aError

MrctspoDoOutgoingCommandPermitted(TBool)

void MrctspoDoOutgoingCommandPermitted ( TBool aIsPermitted ) [private, pure virtual]

OutgoingCommandPermitted .

Parameters

TBool aIsPermitted

MrctspoDoOutgoingNotifyCommandAddressed(TRemConAddress *, TInt)

void MrctspoDoOutgoingNotifyCommandAddressed ( TRemConAddress * aConnection,
TInt aError
) [private, pure virtual]

OutgoingNotifyCommandAddressed

Parameters

TRemConAddress * aConnection
TInt aError

MrctspoDoOutgoingNotifyCommandPermitted(TBool)

void MrctspoDoOutgoingNotifyCommandPermitted ( TBool aIsPermitted ) [private, pure virtual]

OutgoingNotifyCommandPermitted .

Parameters

TBool aIsPermitted

MrctspoDoOutgoingResponsePermitted(TBool)

void MrctspoDoOutgoingResponsePermitted ( TBool aIsPermitted ) [private, pure virtual]

OutgoingResponsePermitted .

Parameters

TBool aIsPermitted

MrctspoDoReAddressNotifies()

void MrctspoDoReAddressNotifies ( ) [private, pure virtual]

ReAddressNotifies

MrctspoSetLocalAddressedClient(const TUid &, const TClientInfo &)

TInt MrctspoSetLocalAddressedClient ( const TUid & aBearerUid,
const TClientInfo & aClientInfo
) [private, pure virtual]

SetLocalAddressedClient .

Parameters

const TUid & aBearerUid
const TClientInfo & aClientInfo

OutgoingCommandAddressed(TInt)

IMPORT_C void OutgoingCommandAddressed ( TInt aError )

Called by the TSP to indicate that it has addressed the outgoing command from the previous AddressOutgoingCommand request.

Parameters

TInt aError The error with which the command was addressed. If other than KErrNone, the command will not be sent by RemCon.

OutgoingCommandPermitted(TBool)

IMPORT_C void OutgoingCommandPermitted ( TBool aIsPermitted )

Called by the TSP to indicate that it has decided whether the outgoing command (from the previous AllowOutgoingCommand request) is permitted or not.

Parameters

TBool aIsPermitted ETrue- the send is permitted, EFalse- the send is not permitted.

OutgoingNotifyCommandAddressed(TRemConAddress *, TInt)

IMPORT_C void OutgoingNotifyCommandAddressed ( TRemConAddress * aConnection,
TInt aError
)

Called by the TSP to indicate that it has addressed the outgoing notify command from the previous AddressOutgoingNotify request.

Parameters

TRemConAddress * aConnection Pointer to the address of the chosen remote target device which is chose through the use-defined way, e.g. choose from the user-defined ini file or any other file the TSP can read and make a choice from it. For notify command addressing, the command will be addressed to the only one target device, so the TSP should only choose one target address. The ownership of TRemConAddress is retained by remcon server.The aConnection should be NULL if no target address is chose.
TInt aError The error with which the command was addressed. If other than KErrNone, the command will not be sent by RemCon.

OutgoingNotifyCommandPermitted(TBool)

IMPORT_C void OutgoingNotifyCommandPermitted ( TBool aIsPermitted )

Called by the TSP to indicate that it has decided whether the outgoing notify command (from the previous AllowOutgoingNotify request) is permitted or not.

Parameters

TBool aIsPermitted ETrue- the send is permitted, EFalse- the send is not permitted.

OutgoingResponsePermitted(TBool)

IMPORT_C void OutgoingResponsePermitted ( TBool aIsPermitted )

Called by the TSP to indicate that it has decided whether the outgoing response (from the previous AllowOutgoingResponse request) is permitted or not.

Parameters

TBool aIsPermitted ETrue- the send is permitted, EFalse- the send is not permitted.

ReAddressNotifies()

IMPORT_C void ReAddressNotifies ( )
Called by the TSP when the outstanding notifies need to be readdressed to other clients. Calling this will result in AddressIncomingNotify requests for each currently outstanding notify.
Note:

RemCon will do this automatically if a client with outstanding notifies exits

SetLocalAddressedClient(const TUid &, const TClientInfo &)

IMPORT_C TInt SetLocalAddressedClient ( const TUid & aBearerUid,
const TClientInfo & aClientInfo
)

Called by the TSP to indicate that a user action has occurred which means that the specified bearer should address commands to the specified client. Addressed commands from that bearer will then be routed to this client until either the TSP calls SetLocalAddressedClient again or RemCon calls SetRemoteAddressedClient.

Parameters

const TUid & aBearerUid The bearer that should change its addressed client
const TClientInfo & aClientInfo

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.