commands/pubsub/pubsub.cif
author Tom Sutcliffe <thomas.sutcliffe@accenture.com>
Thu, 26 Aug 2010 00:49:35 +0100
changeset 45 534b01198c2d
parent 0 7f656887cf89
child 60 3ad902ef5222
permissions -rw-r--r--
Added ENotifyKeypresses and ECaptureCtrlC flags to CCommandBase. Commands can now get keypresses and handle ctrl-C via callbacks instead of having to implement custom active objects. As part of this extended the CCommandBase extension interface to MCommandExtensionsV2 for the new virtual functions KeyPressed(TUint aKeyCode, TUint aModifiers) and CtrlCPressed(). sudo now cleans up correctly by using ECaptureCtrlC.

# pubsub.cif
# 
# Copyright (c) 2010 Accenture. All rights reserved.
# This component and the accompanying materials are made available
# under the terms of the "Eclipse Public License v1.0"
# which accompanies this distribution, and is available
# at the URL "http://www.eclipse.org/legal/epl-v10.html".
# 
# Initial Contributors:
# Accenture - Initial contribution
#

==name pubsub

==short-description

Get and set Publish and Subscribe (P&S) keys.

==long-description

To set integer key zero on category 0x12345678 to 6 (for example) run:

  pubsub set 0x12345678 0 --int 6

For P&S keys of type C<EByteArray>, C<ELargeByteArray>, C<EText> or C<ELargeText>, only the hexdump of the key is given because it is not possible to figure out which are text and which are binary data.

==argument enum command

The command to run.

==enum-value get

Get the value of the given key. Category and Key args must be specified.

==enum-value set

Sets the value. Category and key must be specified along with one of C<--int> or C<--string>.

==enum-value define

Like set, but defines the key first, if necessary, with an C<AlwaysPass> security policy.

==enum-value notify

Print when this value changes. Category and key must be specified.

==argument uint category

RProperty category UID, if applicable for the given command.

==argument uint key

The id of the key (if applicable) for the specified command.

==option int i int

Sets the specified property to this integer value.

==option string s string

Sets the specified property to this 16-bit descriptor value.

==option bool f force

Force read / set this property, disregarding the C<TSecurityPolicy> restrictions on the property. This option can be used with any of the commands. It uses C<RMemoryAccess> to manipulate an C<RPropertyRef> directly.

==option bool b btrace

When specified in conjunction with the C<notify> command, uses C<CBtracePubSub> to get the notifications instead of using C<RProperty::Subscribe> or C<memoryaccess>.

==copyright

Copyright (c) 2008-2010 Accenture. All rights reserved.