cbhey man page

SYNOPSIS

       cbhey   [-hVl]   [-c   type]  ior  verb  [specifiers]  [to
       value|with name1 value1 [name2 ...]]

DESCRIPTION

       The cbhey utility is used to communicate  with  an  active
       CPU Broker object.  The command uses an English-like argu-
       ment style wherein you tell a particular object to perform
       some  action  on  one  of its attributes.  The actions are
       referred to as verbs and the  attributes  are  properties.
       The  utility  then converts your requests into one or more
       RPCs and prints out the result.  For example, to  set  the
       maximum  CPU  allocation  in  the StrictPolicy object, you
       would do:

              [nemo@anemone ~] cbhey file://strict_policy.ior set
              max-cpu to 0.50
              ok

       A  similar  command will then get the value of the maximum
       CPU allocation:

              [nemo@anemone ~] cbhey file://strict_policy.ior get
              max-cpu
              0.50

       In  general,  most objects come prepackaged with their own
       documentation describing how they can be used with  cbhey.
       This  documentation  can be accessed through the getsuites
       verb, like so:

              [nemo@anemone  ~]  cbhey   file://strict_policy.ior
              getsuites
              Property:  max-cpu
                Supported verbs: get set
              Get  or  set the maximum CPU allocation.  The value
              is a floating point number between 0.0 and 1.0 that
              represents  the  percentage  of CPU that the policy
              will allocate to the tasks it manages.

       Most of the time, cbhey is able  to  deduce  the  object's
       type  and  select the appropriate handler.  However, there
       are some cases where this cannot be done or  you  need  to
       communicate with an object that implements multiple inter-
       faces.  In these instances, you can use the -c  option  to
       do a "cast" to the appropriate CORBA interface.  For exam-
       ple, if an object implements "IDL:Broker/RealTimeTask:1.0"
       and  "IDL:BrokerDelegates/Delegate:1.0",  you  can cast it
       like so:

              [nemo@anemone ~] cbhey -c IDL:BrokerDelegates/Dele-
              gate:1.0   file://foo.ior   set   remote-object  to
              file://bar.ior

       You can get a list of all the  supported  interface  types
       using  cbhey  -l.   This will print a list of known shared
       libraries and the types that  they  support.   The  search
       order  for  libraries is: (1) the paths in the environment
       variable CBHEY_PATH  and  (2)  the  Broker's  installation
       directory.

       Available options:


       -h     Print out a usage message.

       -V     Print out a version number.

       -d     Turn on debugging.

       -l     Print out a list of supported interface/implementa-
              tion types.

       -c type
              Cast the object to a different type.

       Available verbs:

       list   List the properties in the object.

       get    Get the value of a property.

       set    Set the value of a property

       getsuites
              Get a description of the object's properties.

       execute
              Execute a property.

       create Create a property.

       delete Delete a property.

EXTENDING CBHEY

       Much like broker_allup(1), cbhey uses shared libraries  to
       do  the  real  work.   Again, the only requirement is that
       they   follow   the   interface    described    in    fac-
       tory_library.h(3).

EXAMPLES

       To  get  the  current policy for the manager designated by
       the IOR in the manager.ior file.

              [nemo@anemone ~] cbhey file://manager.ior get  pol-
              icy

       To  set  the current policy of the same manager to the IOR
       in the strict_policy.ior file.

              [nemo@anemone ~] cbhey file://manager.ior set  pol-
              icy to file://strict_policy.ior

       To  add  the task referenced by "./task.ior" with a period
       of  one  second  to  the  manager  referenced  by  "./man-
       ager.ior".

              [nemo@anemone  ~]  cbhey file://manager.ior execute
              add-task with task file://task.ior period 1s

ENVIRONMENT VARIABLES

       CBHEY_PATH
              A colon separated list of directories and/or  files
              that should be searched for glue libraries.

SEE ALSO

       broker_allup(1), cpubroker(7)

AUTHOR

       The Alchemy project at the University of Utah.

NOTES

       The   Alchemy   project   can  be  found  on  the  web  at
       http://www.cs.utah.edu/flux/alchemy



CPU Broker 1.0.0       2003/11/23 20:08:15               CBHEY(1)