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.

Member Functions Documentation

GetConnections(TSglQue< TRemConAddress > &)

IMPORT_C TIntGetConnections(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 > & aConnectionsA 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 voidIncomingCommandAddressed(TIntaError)

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

Parameters

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

IncomingCommandPermitted(TBool)

IMPORT_C voidIncomingCommandPermitted(TBoolaIsPermitted)

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 aIsPermittedETrue- the send is permitted, EFalse- the send is not permitted.

IncomingNotifyAddressed(TClientInfo *, TInt)

IMPORT_C voidIncomingNotifyAddressed(TClientInfo *aClientInfo,
TIntaError
)

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

Parameters

TClientInfo * aClientInfoPointer 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 aErrorThe error with which the command was addressed. If other than KErrNone, the command will be dropped.

IncomingNotifyPermitted(TBool)

IMPORT_C voidIncomingNotifyPermitted(TBoolaIsPermitted)

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 aIsPermittedETrue- the send is permitted, EFalse- the send is not permitted.

MrctspoDoGetConnections(TSglQue< TRemConAddress > &)

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

Parameters

TSglQue< TRemConAddress > & aConnections

MrctspoDoIncomingCommandAddressed(TInt)

voidMrctspoDoIncomingCommandAddressed(TIntaError)[private, pure virtual]

Parameters

TInt aError

MrctspoDoIncomingCommandPermitted(TBool)

voidMrctspoDoIncomingCommandPermitted(TBoolaIsPermitted)[private, pure virtual]

Parameters

TBool aIsPermitted

MrctspoDoIncomingNotifyAddressed(TClientInfo *, TInt)

voidMrctspoDoIncomingNotifyAddressed(TClientInfo *aClientInfo,
TIntaError
)[private, pure virtual]

Parameters

TClientInfo * aClientInfo
TInt aError

MrctspoDoIncomingNotifyPermitted(TBool)

voidMrctspoDoIncomingNotifyPermitted(TBoolaIsPermitted)[private, pure virtual]

Parameters

TBool aIsPermitted

MrctspoDoOutgoingCommandAddressed(TInt)

voidMrctspoDoOutgoingCommandAddressed(TIntaError)[private, pure virtual]

Parameters

TInt aError

MrctspoDoOutgoingCommandPermitted(TBool)

voidMrctspoDoOutgoingCommandPermitted(TBoolaIsPermitted)[private, pure virtual]

Parameters

TBool aIsPermitted

MrctspoDoOutgoingNotifyCommandAddressed(TRemConAddress *, TInt)

voidMrctspoDoOutgoingNotifyCommandAddressed(TRemConAddress *aConnection,
TIntaError
)[private, pure virtual]

Parameters

TRemConAddress * aConnection
TInt aError

MrctspoDoOutgoingNotifyCommandPermitted(TBool)

voidMrctspoDoOutgoingNotifyCommandPermitted(TBoolaIsPermitted)[private, pure virtual]

Parameters

TBool aIsPermitted

MrctspoDoOutgoingResponsePermitted(TBool)

voidMrctspoDoOutgoingResponsePermitted(TBoolaIsPermitted)[private, pure virtual]

Parameters

TBool aIsPermitted

MrctspoDoReAddressNotifies()

voidMrctspoDoReAddressNotifies()[private, pure virtual]

MrctspoSetLocalAddressedClient(const TUid &, const TClientInfo &)

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

Parameters

const TUid & aBearerUid
const TClientInfo & aClientInfo

OutgoingCommandAddressed(TInt)

IMPORT_C voidOutgoingCommandAddressed(TIntaError)

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

Parameters

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

OutgoingCommandPermitted(TBool)

IMPORT_C voidOutgoingCommandPermitted(TBoolaIsPermitted)

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 aIsPermittedETrue- the send is permitted, EFalse- the send is not permitted.

OutgoingNotifyCommandAddressed(TRemConAddress *, TInt)

IMPORT_C voidOutgoingNotifyCommandAddressed(TRemConAddress *aConnection,
TIntaError
)

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

Parameters

TRemConAddress * aConnectionPointer 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 aErrorThe error with which the command was addressed. If other than KErrNone, the command will not be sent by RemCon.

OutgoingNotifyCommandPermitted(TBool)

IMPORT_C voidOutgoingNotifyCommandPermitted(TBoolaIsPermitted)

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 aIsPermittedETrue- the send is permitted, EFalse- the send is not permitted.

OutgoingResponsePermitted(TBool)

IMPORT_C voidOutgoingResponsePermitted(TBoolaIsPermitted)

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 aIsPermittedETrue- the send is permitted, EFalse- the send is not permitted.

ReAddressNotifies()

IMPORT_C voidReAddressNotifies()
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 TIntSetLocalAddressedClient(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 & aBearerUidThe bearer that should change its addressed client
const TClientInfo & aClientInfo