1 # pubsub.cif

     2 # 

     3 # Copyright (c) 2010 Accenture. All rights reserved.

     4 # This component and the accompanying materials are made available

     5 # under the terms of the "Eclipse Public License v1.0"

     6 # which accompanies this distribution, and is available

     7 # at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 # 

     9 # Initial Contributors:

    10 # Accenture - Initial contribution

    11 #

    12 

    13 ==name pubsub

    14 

    15 ==short-description

    16 

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

    18 

    19 ==long-description

    20 

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

    22 

    23   pubsub set 0x12345678 0 --int 6

    24 

    25 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.

    26 

    27 ==argument enum command

    28 

    29 The command to run.

    30 

    31 ==enum-value get

    32 

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

    34 

    35 ==enum-value set

    36 

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

    38 

    39 ==enum-value define

    40 

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

    42 

    43 ==enum-value notify

    44 

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

    46 

    47 ==argument uint category

    48 

    49 RProperty category UID, if applicable for the given command.

    50 

    51 ==argument uint key

    52 

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

    54 

    55 ==option int i int

    56 

    57 Sets the specified property to this integer value.

    58 

    59 ==option string s string

    60 

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

    62 

    63 ==option bool f force

    64 

    65 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.

    66 

    67 ==option bool b btrace

    68 

    69 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>.

    70 

    71 ==copyright

    72 

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

    74