Bull DPX/20 Podręcznik Użytkownika Strona 1

SC23-2681Bull DPX/20SOMobjects Base ToolkitProgrammer’s Reference ManualAIX86 A2 28AQ 01ORDER REFERENCE

viiiSOMobjects Base Toolkit Programmer’s Reference Manualfind_classes_by_impldef Method 2-43. . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1-88 SOMobjects Base Toolkit: Programmer’s Reference ManualsomGetMethodData MethodPurposeReturns method information for a specified method, which must

SOM Kernel Reference 1-89somGetMethodDescriptor MethodPurposeReturns the method descriptor for a method. Not generally overridden.IDL SyntaxsomId som

1-90 SOMobjects Base Toolkit: Programmer’s Reference ManualsomGetMethodIndex MethodPurposeReturns a class-specific index for a method. Not generally o

SOM Kernel Reference 1-91somGetMethodToken MethodPurposeReturns a method access token for a static method. Not generally overridden.IDL SyntaxsomMToke

1-92 SOMobjects Base Toolkit: Programmer’s Reference ManualsomGetName MethodPurposeReturns the name of a class. Not generally overridden.IDL Syntaxstr

SOM Kernel Reference 1-93somGetNthMethodData MethodPurposeReturns method information for the nth (static or dynamic) method known to a given class.Not

1-94 SOMobjects Base Toolkit: Programmer’s Reference ManualsomGetNthMethodInfo MethodPurposeReturns the somId of the nth (static or dynamic) method kn

SOM Kernel Reference 1-95somGetNumMethods MethodPurposeReturns the number of methods available for a class. Not generally overridden.IDL Syntaxlong s

1-96 SOMobjects Base Toolkit: Programmer’s Reference ManualsomGetNumStaticMethods MethodPurposeObtains the number of static methods available for a cl

SOM Kernel Reference 1-97somGetParents MethodPurposeGets a pointer to a class’s parent (direct base) classes. Not generally overridden.IDL SyntaxSOMCl

ixPrefacesomdFindServerByName Method 2-111. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . somdFindServersByClass M

1-98 SOMobjects Base Toolkit: Programmer’s Reference ManualsomGetVersionNumbers MethodPurposeGets the major and minor version numbers of a class’s imp

SOM Kernel Reference 1-99somLookupMethod MethodPurposePerforms name-lookup method resolution. Not generally overridden.IDL SyntaxsomMethodPtr somLook

1-100 SOMobjects Base Toolkit: Programmer’s Reference ManualOriginal ClassSOMClassRelated InformationMethods: somFindSMethod, somFindSMethodOk Methods

SOM Kernel Reference 1-101somNew, somNewNoInit Methods PurposeCreates a new instance of a class.IDL SyntaxSOMObject somNew ( );SOMObject somNewNoI

1-102 SOMobjects Base Toolkit: Programmer’s Reference ManualsomRenew, somRenewNoInit, somRenewNoInitNoZero,somRenewNoZero Methods PurposeCreates a n

SOM Kernel Reference 1-103Example#include <animal.h>main(){ void *myAnimalCluster; Animal animals[5]; SOMClass animalClass; int animalSize,

1-104 SOMobjects Base Toolkit: Programmer’s Reference ManualsomSupportsMethod MethodPurposeReturns a boolean indicating whether instances of a class s

SOM Kernel Reference 1-105SOMClassMgr ClassDescriptionOne instance of SOMClassMgr is created automatically during SOM initialization. Thisinstance (po

1-106 SOMobjects Base Toolkit: Programmer’s Reference ManualNew MethodsGroup: Basic FunctionssomLoadClassFilesomLocateClassFilesomRegisterClasssomUnlo

SOM Kernel Reference 1-107somClassFromId MethodPurposeFinds a class object, given its somId, if it already exists. Does not load the class.IDL SyntaxS

xSOMobjects Base Toolkit Programmer’s Reference ManualTypeCode_parameter Function 3-47. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1-108 SOMobjects Base Toolkit: Programmer’s Reference ManualsomFindClass MethodPurposeFinds the class object for a class.IDL SyntaxSOMClass somFindCl

SOM Kernel Reference 1-109C Example#include <som.h>/* * This program creates a class object * (from a DLL) without requiring the * usage bind

1-110 SOMobjects Base Toolkit: Programmer’s Reference ManualsomFindClsInFile MethodPurposeFinds the class object for a class, given a filename that ca

SOM Kernel Reference 1-111C Example#include <som.h>/* * This program loads a class and creates * an instance of it without requiring the * bi

1-112 SOMobjects Base Toolkit: Programmer’s Reference ManualsomGetInitFunction MethodPurposeObtains the name of the function that initializes the SOM

SOM Kernel Reference 1-113Original ClassSOMClassMgrRelated InformationMethods: somFindClass, somFindClsInFileFunctions: SOMInitModuleMacros: SOM_Class

1-114 SOMobjects Base Toolkit: Programmer’s Reference ManualsomGetRelatedClasses MethodPurposeReturns an array of class objects that were all register

SOM Kernel Reference 1-115Example#include <som.h>SOMClass myClass, *relatedClasses;string className;long i;className = SOMClass_somGetName (myCl

1-116 SOMobjects Base Toolkit: Programmer’s Reference ManualsomLoadClassFile MethodPurposeDynamically loads a class.IDL SyntaxSOMClass somLoadClassFi

SOM Kernel Reference 1-117somLocateClassFile MethodPurposeDetermines the file that holds a class to be dynamically loaded.IDL Syntaxstring somLocateC

SOM Kernel Reference 1-1Chapter 1. SOM Kernel ReferenceSOMClassClassSOMObjectClassSOM Kernel Class OrganizationDenotes “is a subclass of”SOMClassMgrCl

1-118 SOMobjects Base Toolkit: Programmer’s Reference ManualsomMergeInto MethodPurposeTransfers SOM class registry information to another SOMClassMgr

SOM Kernel Reference 1-119C Example/* * The following example is a hypothetical * implementation of an override of the somNew method * in a subclass o

1-120 SOMobjects Base Toolkit: Programmer’s Reference ManualsomRegisterClass MethodPurposeAdds a class object to the SOM run-time class registry.IDL S

SOM Kernel Reference 1-121somSubstituteClass MethodPurposeCauses the somFindClass, somFindClsInFile, and somClassFromId methods tosubstitute one class

1-122 SOMobjects Base Toolkit: Programmer’s Reference ManualC Example#include ”student.h”#include ”mystud.h”/* Macro form */SOM_SubstituteClass (Stude

SOM Kernel Reference 1-123somUnloadClassFile MethodPurposeUnloads a dynamically loaded class and frees the class’s object.IDL Syntaxlong somUnloadCla

1-124 SOMobjects Base Toolkit: Programmer’s Reference ManualsomUnregisterClass MethodPurposeRemoves a class object from the SOM run-time class registr

SOM Kernel Reference 1-125Original ClassSOMClassMgrRelated InformationMethods: somLoadClassFile, somRegisterClass, somUnloadClassFile

1-126 SOMobjects Base Toolkit: Programmer’s Reference ManualSOMObject ClassSOMObject is the root class for all SOM classes. That is, all SOM classes m

SOM Kernel Reference 1-127Group: DynamicsomDispatchAsomDispatchDsomDispatchLsomDispatchVsomDispatchsomClassDispatchsomCastObjsomResetObjGroup: Develop

1-2 SOMobjects Base Toolkit: Programmer’s Reference ManualsomApply FunctionPurposeInvokes an apply stub. Apply stubs are never invoked directly by SOM

1-128 SOMobjects Base Toolkit: Programmer’s Reference ManualsomCastObj MethodPurposeChanges the behavior of an object to that defined by any ancestor

SOM Kernel Reference 1-129Original ClassSOMObjectRelated InformationMethods: somResetObj

1-130 SOMobjects Base Toolkit: Programmer’s Reference ManualsomDefaultInit MethodPurposeInitializes instance variables and attributes in a newly creat

SOM Kernel Reference 1-131As mentioned previously, the object-initialization framework supported by SOMobjectsallows a class to support additional ini

1-132 SOMobjects Base Toolkit: Programmer’s Reference ManualsomDestruct MethodPurposeUninitializes the receiving object, and (if so directed) frees ob

SOM Kernel Reference 1-133Parametersreceiver A pointer to an object.dofree A boolean indicating whether the caller wants the object storage freed afte

1-134 SOMobjects Base Toolkit: Programmer’s Reference ManualsomDispatch, somClassDispatch MethodsPurposeInvokes a method using dispatch method resolut

SOM Kernel Reference 1-135Parametersreceiver A pointer to the object whose class will be used for method resolution bysomDispatch.clsObj A pointer to

1-136 SOMobjects Base Toolkit: Programmer’s Reference ManualC ExampleGiven class Key that has an attribute keyval of type long and an overridden metho

SOM Kernel Reference 1-137somDispatchX Methods (Obsolete)PurposeInvoke a method using dispatch method resolution. These methods are obsolete.IDL Synt

SOM Kernel Reference 1-3args A pointer to a memory region in which all of the arguments to the methodprocedure have been laid out in consecutive addre

1-138 SOMobjects Base Toolkit: Programmer’s Reference ManualReturn ValueFour families of return values are supported, corresponding to the four forms

SOM Kernel Reference 1-139somDumpSelf MethodPurposeWrites out a detailed description of the receiving object. Intended for use by object clients.Not g

1-140 SOMobjects Base Toolkit: Programmer’s Reference ManualsomDumpSelfInt MethodPurposeOutputs the internal state of an object. Intended to be overri

SOM Kernel Reference 1-141Following is a client program that invokes the somDumpSelf method on “List” objects:#include <list.h>main(){ List L1

1-142 SOMobjects Base Toolkit: Programmer’s Reference ManualsomFree MethodPurposeReleases the storage used by an object and frees the object. Intended

SOM Kernel Reference 1-143somGetClass MethodPurposeReturns a pointer to an object’s class object. Not generally overridden.IDL SyntaxSOMClass somGetC

1-144 SOMobjects Base Toolkit: Programmer’s Reference ManualsomGetClassName MethodPurposeReturns the name of the class of an object. Not generally ove

SOM Kernel Reference 1-145somGetSize MethodPurposeReturns the size of an object. Not generally overridden.IDL Syntaxlong somGetSize ( );Note: For bac

1-146 SOMobjects Base Toolkit: Programmer’s Reference ManualsomInit MethodPurposeInitializes instance variables or attributes in a newly created objec

SOM Kernel Reference 1-147More information and examples on object initialization (especially regarding thesomDefaultInit method) are given in the topi

1-4 SOMobjects Base Toolkit: Programmer’s Reference ManualsomBeginPersistentIds FunctionPurposeTells SOM to begin a “persistent ID interval.”Syntaxvoi

1-148 SOMobjects Base Toolkit: Programmer’s Reference ManualsomIsA MethodPurposeTests whether an object is an instance of a given class or of one of i

SOM Kernel Reference 1-149Original ClassSOMObjectRelated InformationMethods: somDescendedFrom, somIsInstanceOf, somRespondsTo,somSupportsMethod

1-150 SOMobjects Base Toolkit: Programmer’s Reference ManualsomIsInstanceOf MethodPurposeDetermines whether an object is an instance of a specific cla

SOM Kernel Reference 1-151Original ClassSOMObjectRelated InformationMethods: somDescendedFrom, somIsA

1-152 SOMobjects Base Toolkit: Programmer’s Reference ManualsomPrintSelf MethodPurposeOutputs a brief description that identifies the receiving object

SOM Kernel Reference 1-153somResetObj MethodPurposeResets an object’s class to its true class after use of the somCastObj method.Syntaxboolean somRes

1-154 SOMobjects Base Toolkit: Programmer’s Reference ManualsomRespondsTo MethodPurposeTests whether the receiving object supports a given method. Not

SOM Kernel Reference 1-155somUninit MethodPurposeUn-initializes the receiving object. Designed to be overridden by class implementors. Notnormally inv

1-156 SOMobjects Base Toolkit: Programmer’s Reference ManualC ExampleFollowing is the implementation for a class Animal that introduces an attribute s

2-1DSOM Framework ReferenceChapter 2. DSOM Framework ReferenceBOADSOM Framework Class OrganizationDenotes “is a subclass of”SOMDClientProxySOMDObjectS

SOM Kernel Reference 1-5somBuildClass FunctionPurposeAutomates the process of building a new SOM class object.Syntaxvoid somBuildClass (unsigned long

2-2SOMobjects Base Toolkit: Programmer’s Reference ManualNotesThe following information should be considered when using the Distributed SOM (DSOM)fram

2-3DSOM Framework Referenceget_next_response FunctionPurposeReturns the next Request object to complete, after starting multiple requests in parallel.

2-4SOMobjects Base Toolkit: Programmer’s Reference ManualORBfree Function PurposeFrees memory allocated by DSOM for return values and out arguments.C

2-5DSOM Framework Referencesend_multiple_requests Function PurposeInitiates multiple Requests in parallel.C SyntaxORBStatus send_multiple_requests (R

2-6SOMobjects Base Toolkit: Programmer’s Reference ManualExample#include <somd.h>/* sum a set of values in parallel */int parallel_sum(Environme

2-7DSOM Framework ReferencesomdExceptionFree FunctionPurposeFrees the memory held by the exception structure within an Environment structure,regardles

2-8SOMobjects Base Toolkit: Programmer’s Reference ManualSOMD_Init Function PurposeInitializes DSOM in the calling process.C Syntaxvoid SOMD_Init (En

2-9DSOM Framework ReferenceSOMD_NoORBfree FunctionPurposeSpecifies to DSOM that the client program will use the SOMFree function to free memoryallocat

2-10SOMobjects Base Toolkit: Programmer’s Reference ManualSOMD_RegisterCallback Function PurposeRegisters a callback function for handling DSOM reques

2-11DSOM Framework ReferenceExample#include <somd.h>#include <eman.h>#ifdef __OS2__ #pragma linkage(SOMD_RegisterCallback, system) #pragma

1-6 SOMobjects Base Toolkit: Programmer’s Reference ManualsomCheckId FunctionPurposeRegisters a SOM ID.SyntaxsomId somCheckId (somId id);DescriptionT

2-12SOMobjects Base Toolkit: Programmer’s Reference ManualSOMD_Uninit Function PurposeFree system resources allocated for use by DSOM.C Syntaxvoid SO

2-13DSOM Framework ReferenceContext_delete Macro PurposeDeletes a Context object.SyntaxORBStatus Context_delete (Context ctxobj, Environment *env, F

2-14SOMobjects Base Toolkit: Programmer’s Reference ManualRequest_delete Macro PurposeDeletes the memory allocated by the ORB for a Request object.Syn

2-15DSOM Framework ReferenceExample#include <somd.h>#include <repostry.h>#include <intfacdf.h>#include <foo.h> /* provided by

2-16SOMobjects Base Toolkit: Programmer’s Reference ManualBOA ClassDescriptionThe Basic Object Adapter (BOA) defines the basic interfaces that a serve

2-17DSOM Framework Referencechange_implementation MethodPurposeChanges the implementation associated with the referenced object. (Not implemented.)IDL

2-18SOMobjects Base Toolkit: Programmer’s Reference Manualcreate MethodPurposeCreates a “reference” for a local application object which can be export

2-19DSOM Framework ReferenceReturn ValueThe create method returns a pointer to a SOMDObject which refers to a local applicationobject.Example#include

2-20SOMobjects Base Toolkit: Programmer’s Reference Manualdeactivate_impl MethodPurposeIndicates that a server implementation is no longer ready to pr

2-21DSOM Framework Referencedeactivate_obj MethodPurposeIndicates that an object server is no longer ready to process requests. (Not implemented.)IDL

SOM Kernel Reference 1-7somClassResolve FunctionPurposeObtains a pointer to the procedure that implements a static method for instances of aparticular

2-22SOMobjects Base Toolkit: Programmer’s Reference Manualdispose MethodPurposeDestroys an object reference.IDL Syntaxvoid dispose (in SOMDObject obj

2-23DSOM Framework Referenceget_id MethodPurposeReturns reference data associated with the referenced object.IDL SyntaxReferenceData get_id (in SOMDO

2-24SOMobjects Base Toolkit: Programmer’s Reference Manualget_principal MethodPurposeReturns the ID of the principal that issued the request.IDL Synta

2-25DSOM Framework Referenceimpl_is_ready MethodPurposeIndicates that the implementation is ready to process requests.IDL Syntaxvoid impl_is_ready (i

2-26SOMobjects Base Toolkit: Programmer’s Reference Manualobj_is_ready MethodPurposeIndicates that an object (server) is ready to process requests. (N

2-27DSOM Framework Referenceset_exception MethodPurposeReturns an exception to a client.IDL Syntaxvoid set_exception (in exception_type major,in stri

2-28SOMobjects Base Toolkit: Programmer’s Reference ManualContext ClassDescriptionThe Context class implements the CORBA Context object described in s

2-29DSOM Framework Referencecreate_child MethodPurposeCreates a child of a Context object.IDL SyntaxORBStatus create_child (in Identifier ctx_name,ou

2-30SOMobjects Base Toolkit: Programmer’s Reference Manualdelete_values MethodPurposeDeletes property value(s).IDL SyntaxORBStatus delete_values (in

2-31DSOM Framework Referencedestroy Method (for a Context object)PurposeDeletes a Context object.IDL SyntaxORBStatus destroy (in Flags del_flag);Desc

1-8 SOMobjects Base Toolkit: Programmer’s Reference ManualC++ Example// SOM IDL for class A and class B#include <somobj.idl>module scrExample {

2-32SOMobjects Base Toolkit: Programmer’s Reference Manualget_values MethodPurposeRetrieves the specified property values.IDL SyntaxORBStatus get_val

2-33DSOM Framework ReferenceExample#include <somd.h>Environment ev;Context cxt1, cxt2;string *cxt1props;long rc, i, numprops;NVList nvp;...for (

2-34SOMobjects Base Toolkit: Programmer’s Reference Manualset_one_value MethodPurposeAdds a single property to the specified Context object.IDL Syntax

2-35DSOM Framework Referenceset_values MethodPurposeAdds/changes one or more property values in the specified Context object.IDL SyntaxORBStatus set_

2-36SOMobjects Base Toolkit: Programmer’s Reference ManualImplementationDef ClassDescriptionThe ImplementationDef class defines attributes necessary f

2-37DSOM Framework Referenceimpl_refdata_file (string) Contains the full pathname of the file used to store ReferenceData for theserver.impl_refdata_b

2-38SOMobjects Base Toolkit: Programmer’s Reference ManualImplRepository Class DescriptionThe ImplRepository class defines operations necessary to que

2-39DSOM Framework Referenceadd_class_to_impldef MethodPurposeAssociates a class with a server.IDL Syntaxvoid add_class_to_impldef (in ImplId implid,

2-40SOMobjects Base Toolkit: Programmer’s Reference Manualadd_impldef MethodPurposeAdds an implementation definition to the Implementation Repository.

2-41DSOM Framework Referencedelete_impldef MethodPurposeDeletes an implementation definition from the Implementation Repository.IDL Syntaxvoid delete

SOM Kernel Reference 1-9somCompareIds FunctionPurposeDetermines whether two SOM IDs represent the same string.Syntaxint somCompareIds (somId id1, somI

2-42SOMobjects Base Toolkit: Programmer’s Reference Manualfind_all_impldefs MethodPurposeReturns all the implementation definitions in the Implementat

2-43DSOM Framework Referencefind_classes_by_impldef MethodPurposeReturns a sequence of class names associated with a server.IDL Syntaxsequence<stri

2-44SOMobjects Base Toolkit: Programmer’s Reference Manualfind_impldef MethodPurposeReturns a server implementation definition given its ID.IDL Syntax

2-45DSOM Framework Referencefind_impldef_by_alias MethodPurposeReturns a server implementation definition, given its user-friendly alias.IDL SyntaxImp

2-46SOMobjects Base Toolkit: Programmer’s Reference Manualfind_impldef_by_class MethodPurposeReturns a sequence of implementation definitions for serv

2-47DSOM Framework Referenceremove_class_from_all MethodPurposeRemoves the association of a particular class from all servers.Syntaxvoid remove_class

2-48SOMobjects Base Toolkit: Programmer’s Reference Manualremove_class_from_impldef MethodPurposeRemoves the association of a particular class with a

2-49DSOM Framework Referenceupdate_impldef MethodPurposeUpdates an implementation definition in the Implementation Repository.IDL Syntaxvoid update_i

2-50SOMobjects Base Toolkit: Programmer’s Reference ManualNVList ClassDescriptionThe type NamedValue is a standard datatype defined in CORBA (see the

2-51DSOM Framework Referenceadd_item MethodPurposeAdds an item to the specified NVList.IDL SyntaxORBStatus add_item (in Identifier item_name,in TypeC

1-10 SOMobjects Base Toolkit: Programmer’s Reference ManualsomDataResolve FunctionPurposeAccesses instance data within an object.SyntaxsomToken somDat

2-52SOMobjects Base Toolkit: Programmer’s Reference ManualOriginal ClassNVListRelated InformationMethods: free, free_memory, get_count, get_item, set_

2-53DSOM Framework Referencefree MethodPurposeFrees a specified NVList.IDL SyntaxORBStatus free ( );DescriptionThe free method frees an NVList object

2-54SOMobjects Base Toolkit: Programmer’s Reference Manualfree_memory MethodPurposeFrees any dynamically allocated out-arg memory associated with the

2-55DSOM Framework ReferenceOriginal ClassNVListRelated InformationMethods: freeFunctions: ORBfree

2-56SOMobjects Base Toolkit: Programmer’s Reference Manualget_count MethodPurposeReturns the total number of items allocated for a list.IDL SyntaxORBS

2-57DSOM Framework Referenceget_item MethodPurposeReturns the contents of a specified list item.IDL SyntaxORBStatus get_item (in long item_number,out

2-58SOMobjects Base Toolkit: Programmer’s Reference ManualExample#include <somd.h>Environment ev;long i, nArgs;ORBStatus rc;Identifier name;Type

2-59DSOM Framework Referenceset_item MethodPurposeSets the contents of an item in a list.IDL SyntaxORBStatus set_item (in long item_number,in Identif

2-60SOMobjects Base Toolkit: Programmer’s Reference ManualExample#include <somd.h>Environment ev;long i, nArgs;ORBStatus rc;Identifier name;Type

2-61DSOM Framework ReferenceObjectMgr ClassDescriptionThe ObjectMgr class provides a uniform, universal abstraction for any sort of objectmanager. Ob

SOM Kernel Reference 1-11somEndPersistentIds FunctionPurposeTells SOM to end a “persistent ID interval.”Syntaxvoid somEndPersistentIds ( );Descriptio

2-62SOMobjects Base Toolkit: Programmer’s Reference ManualsomdDestroyObject MethodPurposeRequests destruction of the target object.IDL Syntaxvoid som

2-63DSOM Framework ReferencesomdGetIdFromObject MethodPurposeReturns an ID for an object managed by a specified Object Manager.IDL Syntaxstring somdG

2-64SOMobjects Base Toolkit: Programmer’s Reference ManualsomdGetObjectFromId MethodPurposeFinds and activates an object implemented by a specified ob

2-65DSOM Framework ReferencesomdNewObject MethodPurposeReturns a new object of the named class.IDL SyntaxSOMObject somdNewObject (in Identifier objcla

2-66SOMobjects Base Toolkit: Programmer’s Reference ManualsomdReleaseObject MethodPurposeIndicates that the client has finished using the object.IDL S

2-67DSOM Framework ReferenceORB Class DescriptionThe ORB class implements the CORBA ORB object described in Chapter 8 of the CORBA1.1 specification. T

2-68SOMobjects Base Toolkit: Programmer’s Reference Manualcreate_list MethodPurposeCreates an NVList of the specified size.IDL SyntaxORBStatus create

2-69DSOM Framework Referencecreate_operation_list MethodPurposeCreates an NVList initialized with the argument descriptions for a given operation.IDL

2-70SOMobjects Base Toolkit: Programmer’s Reference Manualget_default_context MethodPurposeReturns the default process Context object.IDL SyntaxORBSta

2-71DSOM Framework Referenceobject_to_string MethodPurposeConverts an object reference to an external form (string) which can be stored outside theORB

1-12 SOMobjects Base Toolkit: Programmer’s Reference ManualsomEnvironmentEnd FunctionPurposeProvides general cleanup for applications.Syntaxvoid somEn

2-72SOMobjects Base Toolkit: Programmer’s Reference Manualstring_to_object MethodPurposeConverts an externalized (string) form of an object reference

2-73DSOM Framework ReferencePrincipal ClassDescriptionThe Principal class defines attributes which identify the user id and host name of theoriginator

2-74SOMobjects Base Toolkit: Programmer’s Reference ManualRequest ClassDescriptionThe Request class implements the CORBA Request object described in s

2-75DSOM Framework Referenceadd_arg MethodPurposeIncrementally adds an argument to a Request object.IDL SyntaxORBStatus add_arg (in Identifier name,i

2-76SOMobjects Base Toolkit: Programmer’s Reference ManualReturn ValueThe add_arg method returns an ORBStatus value representing the return code of th

2-77DSOM Framework Referencedestroy Method (for a Request object)PurposeDeletes the memory allocated by the ORB for a Request object.IDL SyntaxORBSta

2-78SOMobjects Base Toolkit: Programmer’s Reference ManualExample#include <somd.h>#include <repostry.h>#include <intfacdf.h>#include

2-79DSOM Framework Referenceget_response MethodPurposeDetermines whether an asynchronous Request has completed.IDL SyntaxORBStatus get_response (in F

2-80SOMobjects Base Toolkit: Programmer’s Reference ManualExample#include <somd.h>#include <repostry.h>#include <intfacdf.h>#include

2-81DSOM Framework Referenceinvoke MethodPurposeInvokes a Request synchronously, waiting for the response.IDL SyntaxORBStatus invoke (in Flags invoke

SOM Kernel Reference 1-13somEnvironmentNew FunctionPurposeInitializes the SOM runtime environment.SyntaxSOMClassMgr somEnvironmentNew ( );Description

2-82SOMobjects Base Toolkit: Programmer’s Reference Manual/* Get the OperationDef from the Interface Repository. */opdef = _lookup_id(SOM_InterfaceRep

2-83DSOM Framework Referencesend MethodPurposeInvokes a Request asynchronously.IDL SyntaxORBStatus send (in Flags invoke_flags);DescriptionThe send m

2-84SOMobjects Base Toolkit: Programmer’s Reference ManualExample#include <somd.h>#include <repostry.h>#include <intfacdf.h>#include

2-85DSOM Framework ReferenceSOMDClientProxy ClassDescriptionThe SOMDClientProxy class implements DSOM proxy objects in Clients.SOMDClientProxy overrid

2-86SOMobjects Base Toolkit: Programmer’s Reference ManualOverridden methodscreate_requestcreate_request_argsis_proxyreleasesomDispatchsomDispatchA, s

2-87DSOM Framework ReferencesomdProxyFree MethodPurposeExecutes somFree on the local proxy object.IDL Syntaxvoid somdProxyFree ( );DescriptionThe som

2-88SOMobjects Base Toolkit: Programmer’s Reference ManualsomdProxyGetClass MethodPurposeReturns the class object for the local proxy object.IDL Synta

2-89DSOM Framework ReferencesomdProxyGetClassName MethodPurposeReturns the class name for the local proxy object.IDL Syntaxstring somdProxyGetClassNa

2-90SOMobjects Base Toolkit: Programmer’s Reference ManualsomdReleaseResources MethodPurposeInstructs a proxy object to release any memory it is holdi

2-91DSOM Framework ReferenceOriginal ClassSOMDClientProxyRelated InformationMethods: release

1-14 SOMobjects Base Toolkit: Programmer’s Reference ManualsomExceptionFree FunctionPurposeFrees the memory held by the exception structure within an

2-92SOMobjects Base Toolkit: Programmer’s Reference ManualsomdTargetFree MethodPurposeForwards the somFree method call to the remote target object.IDL

2-93DSOM Framework ReferencesomdTargetGetClass MethodPurposeReturns (a proxy for) the class object for the remote target object.IDL SyntaxSOMClass so

2-94SOMobjects Base Toolkit: Programmer’s Reference ManualsomdTargetGetClassName MethodPurposeReturns the class name for the remote target object.IDL

2-95DSOM Framework ReferenceSOMDObject ClassDescriptionThe SOMDObject class implements the methods that can be applied to all CORBA objectreferences:

2-96SOMobjects Base Toolkit: Programmer’s Reference Manualcreate_request MethodPurposeCreates a request to execute a particular operation on the refer

2-97DSOM Framework ReferenceExample#include <somd.h>#include <repostry.h>#include <intfacdf.h>#include <foo.h> /* provided by

2-98SOMobjects Base Toolkit: Programmer’s Reference Manualcreate_request_args MethodPurposeCreates an argument list appropriate for the specified oper

2-99DSOM Framework ReferenceExample#include <somd.h>#include <repostry.h>#include <intfacdf.h>#include <foo.h> /* provided by

2-100SOMobjects Base Toolkit: Programmer’s Reference Manualduplicate MethodPurposeMakes a duplicate of an object reference.IDL SyntaxSOMDObject dupli

2-101DSOM Framework Referenceget_implementation MethodPurposeReturns the implementation definition for the referenced object.IDL SyntaxImplementationD

SOM Kernel Reference 1-15somExceptionId FunctionPurposeGets the name of the exception contained in an Environment structure.Syntaxstring somException

2-102SOMobjects Base Toolkit: Programmer’s Reference Manualget_interface MethodPurposeReturns the interface definition object for the referenced objec

2-103DSOM Framework Referenceis_constant MethodPurposeTests to see if the object reference is a constant (that is, its ReferenceData is a constantvalu

2-104SOMobjects Base Toolkit: Programmer’s Reference Manualis_nil MethodPurposeTests to see if the object reference is nil.IDL Syntaxboolean is_nil (

2-105DSOM Framework Referenceis_proxy MethodPurposeTests to see if the object reference is a proxy.IDL Syntaxboolean is_proxy( );DescriptionThe is_pro

2-106SOMobjects Base Toolkit: Programmer’s Reference Manualis_SOM_ref MethodPurposeTests to see if the object reference is a simple reference to a SOM

2-107DSOM Framework Referencerelease MethodPurposeReleases the memory associated with the specified object reference.IDL Syntaxvoid release ( );Descr

2-108SOMobjects Base Toolkit: Programmer’s Reference ManualSOMDObjectMgr ClassDescriptionThe SOMDObjectMgr class is derived from ObjectMgr class and p

2-109DSOM Framework ReferencesomdFindAnyServerByClass MethodPurposeFinds a server capable of creating the specified object.IDL SyntaxSOMDServer somdF

2-110SOMobjects Base Toolkit: Programmer’s Reference ManualsomdFindServer MethodPurposeFinds a server given its ImplementationDef ID.IDL SyntaxSOMDSer

2-111DSOM Framework ReferencesomdFindServerByName MethodPurposeFinds a server given its ImplementationDef name (alias).IDL SyntaxSOMDServer somdFindS

1-16 SOMobjects Base Toolkit: Programmer’s Reference ManualsomExceptionValue FunctionPurposeGets the value of the exception contained in an Environmen

2-112SOMobjects Base Toolkit: Programmer’s Reference ManualsomdFindServersByClass MethodPurposeFinds all servers capable of creating a particular obje

2-113DSOM Framework ReferenceSOMDServer ClassDescriptionThe SOMDServer class is a base class that defines and implements methods for managingobjects i

2-114SOMobjects Base Toolkit: Programmer’s Reference ManualsomdCreateObj MethodPurposeCreates an object of the specified class.IDL SyntaxSOMObject so

2-115DSOM Framework ReferencesomdDeleteObj MethodPurposeDeletes the specified object.IDL Syntaxvoid somdDeleteObj (in SOMObject somobj );DescriptionT

2-116SOMobjects Base Toolkit: Programmer’s Reference ManualsomdDispatchMethod MethodPurposeDispatch a method on the specified SOM object.IDL Syntaxvoi

2-117DSOM Framework ReferencesomdGetClassObj MethodPurposeCreates a class object for the specified class.IDL SyntaxSOMClass somdGetClassObj (in Ident

2-118SOMobjects Base Toolkit: Programmer’s Reference ManualsomdObjReferencesCached MethodPurposeIndicates whether a server object retains ownership of

2-119DSOM Framework ReferencesomdRefFromSOMObj MethodPurposeReturns an object reference corresponding to the specified SOM object.IDL SyntaxSOMDObject

2-120SOMobjects Base Toolkit: Programmer’s Reference ManualsomdSOMObjFromRef MethodPurposeReturns the SOM object corresponding to the specified object

2-121DSOM Framework ReferenceSOMDServerMgr ClassDescriptionThe SOMDServerMgr class provides a programmatic interface to manage serverprocesses. At pre

SOM Kernel Reference 1-17somGetGlobalEnvironment FunctionPurposeReturns a pointer to the current global Environment structure.SyntaxEnvironment *somG

2-122SOMobjects Base Toolkit: Programmer’s Reference ManualsomdDisableServer MethodPurposeDisables a server process from starting until it is explicit

2-123DSOM Framework ReferencesomdEnableServer MethodPurposeEnables a server process so that it can be started when required. Initially, all serverproc

2-124SOMobjects Base Toolkit: Programmer’s Reference ManualsomdIsServerEnabled MethodPurposeDetermines whether a server process is enabled or not.IDL

2-125DSOM Framework ReferencesomdListServer MethodPurposeQueries the state of a server process.IDL SyntaxORBStatus somdListServer (in string server_a

2-126SOMobjects Base Toolkit: Programmer’s Reference ManualsomdRestartServer MethodPurposeRestarts a server process.IDL SyntaxORBStatus somdRestartSe

2-127DSOM Framework ReferencesomdShutdownServer MethodPurposeStops a server process.IDL SyntaxORBStatus somdShutdownServer (in string server_alias);D

2-128SOMobjects Base Toolkit: Programmer’s Reference ManualsomdStartServer MethodPurposeStarts a server process.IDL SyntaxORBStatus somdStartServer (

2-129DSOM Framework ReferenceSOMOA ClassDescriptionThe SOMOA class is DSOM’s basic object adapter. SOMOA is a subclass of the abstractBOA class, and p

2-130SOMobjects Base Toolkit: Programmer’s Reference Manualactivate_impl_failed MethodPurposeSends a message to the DSOM daemon indicating that a serv

2-131DSOM Framework Referencechange_id MethodPurposeChanges the reference data associated with an object.IDL Syntaxvoid change_id (in SOMDObject objr

Bull DPX/20SOMobjects Base ToolkitProgrammer’s Reference ManualAIXSoftwareJune 1995BULL S.A. CEDOCAtelier de ReproductionFRAN–231331 Avenue Patton BP

1-18 SOMobjects Base Toolkit: Programmer’s Reference ManualsomIdFromString FunctionPurposeReturns the SOM ID corresponding to a given text string.Synt

2-132SOMobjects Base Toolkit: Programmer’s Reference Manualcreate_constant MethodPurposeCreates a “constant” object reference.IDL SyntaxSOMDObject cr

2-133DSOM Framework ReferenceExample#include <somd.h>#include <repostry.h>#include <intfacdf.h>Environment ev;ReferenceData id;Inter

2-134SOMobjects Base Toolkit: Programmer’s Reference Manualcreate_SOM_ref MethodPurposeCreates a simple, transient DSOM reference to a SOM object.IDL

2-135DSOM Framework Referenceexecute_next_request MethodPurposeReceive a request message, execute the request, and return to the caller.IDL SyntaxORBS

2-136SOMobjects Base Toolkit: Programmer’s Reference Manualexecute_request_loop MethodPurposeReceives a request message, executes the request, and ret

2-137DSOM Framework ReferenceRelated InformationFunctions: SOMD_RegisterCallbackMethods: execute_next_requestSee Chapter 12 of the SOM Toolkit User’s

2-138SOMobjects Base Toolkit: Programmer’s Reference Manualget_SOM_object MethodPurposeGet the SOM object associated with a simple DSOM reference.IDL

3-1Interface Repository Framework ReferenceChapter 3. Interface Repository Framework ReferenceInterface Repository Framework Class OrganizationDenotes

3-2SOMobjects Base Toolkit Programmer’s Reference ManualAttributeDef ClassDescriptionThe AttributeDef class provides the interface for attribute defin

3-3Interface Repository Framework ReferenceNew MethodsNone.Overriding MethodssomInitsomUninitsomDumpSelfsomDumpSelfIntdescribe

SOM Kernel Reference 1-19somIsObj FunctionPurposeFailsafe routine to determine whether a pointer references a valid SOM object.Syntaxboolean somIsObj

3-4SOMobjects Base Toolkit Programmer’s Reference ManualConstantDef ClassDescriptionThe ConstantDef class provides the interface for constant definiti

3-5Interface Repository Framework ReferenceNew MethodsNone.Overriding MethodssomInitsomUninitsomDumpSelfsomDumpSelfIntdescribe

3-6SOMobjects Base Toolkit Programmer’s Reference ManualContained ClassDescriptionThe Contained class is the most generic form of interface for object

3-7Interface Repository Framework ReferencesomModifiers (sequence<somModifier>)The somModifiers attribute is a sequence containing all modifier

3-8SOMobjects Base Toolkit Programmer’s Reference Manualdescribe MethodPurposeReturns a structure containing information defined in the IDL specificat

3-9Interface Repository Framework ReferenceExampleHere is a code fragment written in C that uses the describe method:#include <containd.h>#inclu

3-10SOMobjects Base Toolkit Programmer’s Reference Manualwithin MethodPurposeReturns a list of objects (in the Interface Repository) that contain a sp

3-11Interface Repository Framework ReferenceExampleHere is a code fragment written in C that uses the within method:#include <containd.h>#includ

3-12SOMobjects Base Toolkit Programmer’s Reference ManualContainer ClassDescriptionThe Container class is a generic interface that is common to all of

3-13Interface Repository Framework Referencecontents MethodPurposeReturns a sequence indicating the objects contained within a specified Container obj

1-20 SOMobjects Base Toolkit: Programmer’s Reference ManualsomLPrintf FunctionPurposePrints a formatted string in the manner of the C printf function,

3-14SOMobjects Base Toolkit Programmer’s Reference ManualReturn ValueThe contents method returns a sequence of pointers to objects contained within th

3-15Interface Repository Framework Referencedescribe_contents MethodPurposeReturns a sequence of descriptions of the objects contained within a specif

3-16SOMobjects Base Toolkit Programmer’s Reference Manualexclude_inheritedA boolean value: TRUE to exclude any inherited objects, or FALSE toinclude a

3-17Interface Repository Framework Referencelookup_name MethodPurposeLocates an object by name within a specified Container object of the Interface Re

3-18SOMobjects Base Toolkit Programmer’s Reference ManualReturn ValueThe lookup_name method returns a sequence of pointers to objects of the given nam

3-19Interface Repository Framework ReferenceExceptionDef ClassDescriptionThe ExceptionDef class provides the interface for exception definitions in th

3-20SOMobjects Base Toolkit Programmer’s Reference ManualNew MethodsNone.Overriding MethodssomInitsomUninitsomDumpSelfsomDumpSelfIntdescribe

3-21Interface Repository Framework ReferenceInterfaceDef ClassDescriptionThe InterfaceDef class provides the interface for interface definitions in th

3-22SOMobjects Base Toolkit Programmer’s Reference ManualAttributesAll attributes of the InterfaceDef class provide access to information kept within

3-23Interface Repository Framework Referencedescribe_interface MethodPurposeReturns (from the Interface Repository) a description of all the methods a

SOM Kernel Reference 1-21somMainProgram FunctionPurposePerforms SOM initialization on behalf of a new program.SyntaxSOMClassMgr *somMainProgram ( );De

3-24SOMobjects Base Toolkit Programmer’s Reference ManualExampleHere is a code fragment written in C that uses the describe_interface method:#include

3-25Interface Repository Framework ReferenceModuleDef ClassDescriptionThe ModuleDef class provides the interface for module definitions in the Interfa

3-26SOMobjects Base Toolkit Programmer’s Reference ManualOperationDef ClassDescriptionThe OperationDef class provides the interface for operation (met

3-27Interface Repository Framework ReferenceAttributesFollowing is a list of each available attribute, with its corresponding type in parentheses,foll

3-28SOMobjects Base Toolkit Programmer’s Reference ManualParameterDef ClassDescriptionThe ParameterDef class provides the interface for parameter defi

3-29Interface Repository Framework ReferenceOverriding MethodssomInitsomUninitsomDumpSelfsomDumpSelfIntdescribe

3-30SOMobjects Base Toolkit Programmer’s Reference ManualRepository ClassDescriptionThe Repository class provides global access to SOM’s CORBA-complia

3-31Interface Repository Framework Referencelookup_id MethodPurposeReturns the object having a specified RepositoryId.IDL SyntaxContained lookup_id (

3-32SOMobjects Base Toolkit Programmer’s Reference ManualOriginal ClassRepositoryRelated InformationMethods: lookup_modifier, lookup_name, contents, w

3-33Interface Repository Framework Referencelookup_modifier MethodPurposeReturns the value of a given SOM modifier for a specified object [that is, fo

1-22 SOMobjects Base Toolkit: Programmer’s Reference ManualsomParentNumResolve FunctionPurposeObtains a pointer to a procedure that implements a metho

3-34SOMobjects Base Toolkit Programmer’s Reference ManualExampleHere is a code fragment written in C that uses the lookup_modifier method:#include <

3-35Interface Repository Framework Referencerelease_cache MethodPurposePermits the Repository object to release the memory occupied by Interface Repos

3-36SOMobjects Base Toolkit Programmer’s Reference ManualTypeDef ClassDescriptionThe TypeDef class provides the interface for typedef definitions in t

3-37Interface Repository Framework ReferenceTypeCode_alignment FunctionPurposeSupplies the alignment value for a given TypeCode.IDL Syntaxshort TypeC

3-38SOMobjects Base Toolkit Programmer’s Reference ManualTypeCode_copy FunctionPurposeCreates a new copy of a given TypeCode.IDL SyntaxTypeCode TypeC

3-39Interface Repository Framework ReferenceTypeCode_equal FunctionPurposeCompares two TypeCodes for equality.IDL Syntaxboolean TypeCode_equal (TypeC

3-40SOMobjects Base Toolkit Programmer’s Reference ManualTypeCode_free FunctionPurposeDestroys a given TypeCode by freeing all of the memory used to r

3-41Interface Repository Framework ReferenceTypeCode_kind FunctionPurposeCategorizes the abstract data type described by a TypeCode.IDL SyntaxTCKind

3-42SOMobjects Base Toolkit Programmer’s Reference ManualTypeCode Information per TCKind CategoryTCKind Parameters Type Functiontk_objref 1 string The

3-43Interface Repository Framework ReferenceThe tk_pointer TypeCode contains only one parameter—a TypeCode whichdescribes the data type that the point

SOM Kernel Reference 1-23C++ Example// SOM IDL for class A and class B#include <somobj.idl>module spnrExample { interface A : SOMObject { voi

3-44SOMobjects Base Toolkit Programmer’s Reference ManualTypeCodeNew FunctionPurposeCreates a new TypeCode instance.SyntaxTypeCode TypeCodeNew (TCKin

3-45Interface Repository Framework ReferencestructOrUnionNameA string that gives the name of a struct or union that has been previouslynamed in the cu

3-46SOMobjects Base Toolkit Programmer’s Reference ManualTypeCode_param_count FunctionPurposeObtains the number of parameters available in a given Typ

3-47Interface Repository Framework ReferenceTypeCode_parameter FunctionPurposeObtains a specified parameter from a given TypeCode.IDL Syntaxany TypeC

3-48SOMobjects Base Toolkit Programmer’s Reference ManualSince all TypeCode parameters have one of only three types (string, TypeCode, or long),the _t

3-49Interface Repository Framework ReferenceTypeCode_print FunctionPurposeWrites all of the information contained in a given TypeCode to stdout.IDL Sy

3-50SOMobjects Base Toolkit Programmer’s Reference ManualTypeCode_setAlignment FunctionPurposeOverrides the default alignment value associated with a

3-51Interface Repository Framework ReferenceTypeCode_size FunctionPurposeProvides the minimum size of an instance of the abstract data type described

3-52SOMobjects Base Toolkit Programmer’s Reference Manual

Metaclass Framework Reference 4-1Chapter 4. Metaclass Framework ReferenceMetaclass Class OrganizationLegend:Subclass ofInstance ofMetaclass Class Ordi

1-24 SOMobjects Base Toolkit: Programmer’s Reference ManualsomParentResolve FunctionPurposeObtains a pointer to a procedure that implements a method,

4-2 SOMobjects Base Toolkit Programmer’s ReferenceManualSOMMBeforeAfter MetaclassDescriptionSOMMBeforeAfter is a metaclass that defines two methods (s

Metaclass Framework Reference 4-3sommAfterMethod MethodPurposeSpecifies a method that is automatically called after execution of each client method.ID

4-4 SOMobjects Base Toolkit Programmer’s ReferenceManualExampleThe following figure shows an invocation of “myMethod” on “myObject”. Because“myObject”

Metaclass Framework Reference 4-5sommBeforeMethod MethodPurposeSpecifies a method that is automatically called before execution of each client method.

4-6 SOMobjects Base Toolkit Programmer’s ReferenceManualExampleThe following figure shows an invocation of “myMethod” on “myObject”. Because“myObject”

Metaclass Framework Reference 4-7SOMMSingleInstance MetaclassDescriptionSOMMSingleInstance can be specified as the metaclass when a class implementor

4-8 SOMobjects Base Toolkit Programmer’s ReferenceManualsommGetSingleInstance MethodPurposeGets the one instance of a specified class for which only a

Metaclass Framework Reference 4-9SOMMTraced MetaclassDescriptionSOMMTraced is a metaclass that facilitates tracing of method invocations. Whenever ame

4-10 SOMobjects Base Toolkit Programmer’s ReferenceManual

Event Management Framework Reference 5-1Chapter 5. Event Management Framework ReferenceEvent Management Framework Class OrganizationDenotes “is a subc

SOM Kernel Reference 1-25somPrefixLevel FunctionPurposeOutputs blanks to prefix a line at the indicated level.Syntaxvoid somPrefixLevel (long level);

5-2 SOMobjects Base Toolkit Programmer’s ReferenceManualSOMEClientEvent ClassDescriptionThis class describes generic client events within the Event Ma

Event Management Framework Reference 5-3somevGetEventClientData MethodPurposeReturns the user-defined data associated with a client event.IDL Syntaxvo

5-4 SOMobjects Base Toolkit Programmer’s ReferenceManualsomevGetEventClientType MethodPurposeReturns the type name of a client event.IDL Syntaxstring

Event Management Framework Reference 5-5somevSetEventClientData MethodPurposeSets the user-defined data of a client event.IDL Syntaxvoid somevSetEven

5-6 SOMobjects Base Toolkit Programmer’s ReferenceManualsomevSetEventClientType MethodPurposeSets the type name of a client event.IDL Syntaxvoid some

Event Management Framework Reference 5-7SOMEEMan ClassDescriptionThe Event Manager class (EMan) is used to handle several input events. The main purpo

5-8 SOMobjects Base Toolkit Programmer’s ReferenceManualNew MethodssomeGetEManSemsomeChangeRegDatasomeProcessEventsomeProcessEventssomeQueueEventsomeR

Event Management Framework Reference 5-9someChangeRegData MethodPurposeChanges the registration data associated with a specified registration ID.IDL S

5-10 SOMobjects Base Toolkit Programmer’s ReferenceManualsomeGetEManSem MethodPurposeAcquires EMan semaphores to achieve mutual exclusion with EMan’s

Event Management Framework Reference 5-11someProcessEvent MethodPurposeProcesses one event.IDL Syntaxvoid someProcessEvent (in unsigned long mask);De

1-26 SOMobjects Base Toolkit: Programmer’s Reference ManualsomPrintf FunctionPurposePrints a formatted string in the manner of the C printf function.S

5-12 SOMobjects Base Toolkit Programmer’s ReferenceManualsomeProcessEvents MethodPurposeProcesses infinite events.IDL Syntaxvoid someProcessEvents (

Event Management Framework Reference 5-13someQueueEvent MethodPurposeEnqueues the specified client event.IDL Syntaxvoid someQueueEvent (in SOMEClient

5-14 SOMobjects Base Toolkit Programmer’s ReferenceManualsomeRegister MethodPurposeRegisters an object/method pair with EMan, given a specified regist

Event Management Framework Reference 5-15Original ClassSOMEEManRelated InformationMethods: someRegisterEv, someRegisterProc, someUnRegisterAlso see th

5-16 SOMobjects Base Toolkit Programmer’s ReferenceManualsomeRegisterEv MethodPurposeRegisters the (object, method, Environment parameter) combination

Event Management Framework Reference 5-17Example#include <eman.h>#include <emobj.h> Environment *testEnv = somGetGlobalEnvironment();Envir

5-18 SOMobjects Base Toolkit Programmer’s ReferenceManualsomeRegisterProc MethodPurposeRegister the procedure with EMan given the specified registerDa

Event Management Framework Reference 5-19Original ClassSOMEEManRelated InformationMethods: someRegister, someRegisterEv, someUnRegister

5-20 SOMobjects Base Toolkit Programmer’s ReferenceManualsomeReleaseEManSem MethodPurposeReleases the semaphore obtained by the someGetEManSem method.

Event Management Framework Reference 5-21someShutdown MethodPurposeShuts down an EMan event loop. (That is, this makes the someProcessEvents return!)I

SOM Kernel Reference 1-27somRegisterId FunctionPurposeRegisters a SOM ID and determines whether or not it was previously registered.Syntaxint somRegi

5-22 SOMobjects Base Toolkit Programmer’s ReferenceManualsomeUnRegister MethodPurposeUnregisters the event interest associated with a specified regist

Event Management Framework Reference 5-23SOMEEMRegisterData ClassDescriptionThis class is used for holding registration information for event types to

5-24 SOMobjects Base Toolkit Programmer’s ReferenceManualsomeClearRegData MethodPurposeClears the registration data.IDL Syntaxvoid someClearRegData (

Event Management Framework Reference 5-25someSetRegDataClientType MethodPurposeSets the type name for a client event.IDL Syntaxvoid someSetRegDataCli

5-26 SOMobjects Base Toolkit Programmer’s ReferenceManualsomeSetRegDataEventMask MethodPurposeSets the generic event mask within the registration data

Event Management Framework Reference 5-27someSetRegDataSink MethodPurposeSets the file descriptor (or socket ID, or message queue ID) for the sink eve

5-28 SOMobjects Base Toolkit Programmer’s ReferenceManualsomeSetRegDataSinkMask MethodPurposeSets the sink mask within the registration data object.ID

Event Management Framework Reference 5-29someSetRegDataTimerCount MethodPurposeSets the number of times the timer will trigger, within the registratio

5-30 SOMobjects Base Toolkit Programmer’s ReferenceManualsomeSetRegDataTimerInterval MethodPurposeSets the timer interval within the registration data

Event Management Framework Reference 5-31SOMEEvent ClassDescriptionThis is the base class for all generic events within the Event Manager (EMan). It s

The following copyright notice protects this book under the Copyright laws of the United States and othercountries which prohibit such actions as, but

1-28 SOMobjects Base Toolkit: Programmer’s Reference ManualsomResolve FunctionPurposeObtains a pointer to the procedure that implements a method for a

5-32 SOMobjects Base Toolkit Programmer’s ReferenceManualsomevGetEventTime MethodPurposeReturns the time of the generic event in milliseconds.IDL Synt

Event Management Framework Reference 5-33somevGetEventType MethodPurposeReturns the type of the generic event.IDL Syntaxunsigned longsomevGetEventType

5-34 SOMobjects Base Toolkit Programmer’s ReferenceManualsomevSetEventTime MethodPurposeSets the time of the generic event (time is in milliseconds).I

Event Management Framework Reference 5-35somevSetEventType MethodPurposeSets the type of the generic event.IDL Syntaxvoid somevSetEventType (in unsig

5-36 SOMobjects Base Toolkit Programmer’s ReferenceManualSOMESinkEvent ClassDescriptionThis class describes a sink event that is generated by EMan whe

Event Management Framework Reference 5-37somevGetEventSink MethodPurposeReturns the sink, or source of I/O, of the generic sink event.IDL Syntaxlong

5-38 SOMobjects Base Toolkit Programmer’s ReferenceManualsomevSetEventSink MethodPurposeSets the sink, or source of I/O, of the generic sink event.IDL

Event Management Framework Reference 5-39SOMETimerEvent ClassDescriptionThis class describes a timer event that is generated by EMan when any of its r

5-40 SOMobjects Base Toolkit Programmer’s ReferenceManualsomevGetEventInterval MethodPurposeReturns the interval of the generic timer event (time in m

Event Management Framework Reference 5-41somevSetEventInterval MethodPurposeSets the interval of the generic timer event (in milliseconds).IDL Syntaxv

SOM Kernel Reference 1-29C Example// SOM IDL for class A and class B#include <somobj.idl>module srExample { interface A : SOMObject { void fo

5-42 SOMobjects Base Toolkit Programmer’s ReferenceManualSOMEWorkProcEvent ClassDescriptionThis class describes a work procedure event object. It curr

X-1IndexIndexAactivate_impl_failed method, 2-130add_arg method, 2-75add_class_to_impldef method, 2-39add_impldef method, 2-40add_item method, 2-51Attr

X-2SOMobjects Base Toolkit Programmer’s Reference Manualcreate_operation_list method, 2-69get_default_context method, 2-70object_to_string method, 2-7

X-3Indexget_implementation method, 2-101get_interface method, 2-102get_item method, 2-57get_next_response function, 2-3get_principal method, 2-24get_r

X-4SOMobjects Base Toolkit Programmer’s Reference Manualset_values method, 2-35SOM kernel, 1-1FunctionssomApply function, 1-2somBeginPersistentIds fun

X-5IndexsomRespondsTo method, 1-154somUninit method, 1-155SOM metaclass classes/methods. See “MetaclassFramework”somAddDynamicMethod method, 1-72somAl

X-6SOMobjects Base Toolkit Programmer’s Reference ManualsomevSetEventType method, 5-35SOMEWorkProcEvent class, 5-42See also “Event Management Framewor

X-7IndexUtility metaclasses. See “Metaclass Framework”Wwithin method, 3-10

X-8SOMobjects Base Toolkit Programmer’s Reference Manual

Vos remarques sur ce document / Technical publication remark formTitre / Title :Bull DPX/20 SOMobjects Base Toolkit Programmer’s Reference Manual Nº

1-30 SOMobjects Base Toolkit: Programmer’s Reference ManualsomResolveByName FunctionPurposeObtains a pointer to the procedure that implements a method

BULL S.A. CEDOCAtelier de ReproductionFRAN–231331 Avenue Patton BP 42849005 ANGERS CEDEXFRANCE86 A2 28AQ 01ORDER REFERENCEPLACE BAR CODE IN LOWERLEFT

Utiliser les marques de découpe pour obtenir les étiquettes.Use the cut marks to get the labels.AIX86 A2 28AQ 01SOMobjects BaseToolkitProgrammer’sRefe

SOM Kernel Reference 1-31somSetException FunctionPurposeSets an exception value in an Environment structure.Syntaxvoid somSetException (Environment *

1-32 SOMobjects Base Toolkit: Programmer’s Reference ManualC Example/* IDL declaration of class X: */ interface X : SOMObject { exception OUCH

SOM Kernel Reference 1-33somSetExpectedIds FunctionPurposeTells SOM how many unique SOM IDs a client program expects to use.Syntaxvoid somSetExpected

1-34 SOMobjects Base Toolkit: Programmer’s Reference ManualsomSetOutChar FunctionPurposeChanges the behavior of the somPrintf function.Syntaxvoid som

SOM Kernel Reference 1-35somStringFromId FunctionPurposeReturns the string that a SOM ID represents.Syntaxstring somStringFromId (somId id);Descripti

1-36 SOMobjects Base Toolkit: Programmer’s Reference ManualsomTotalRegIds FunctionPurposeReturns the total number of SOM IDs that have been registered

SOM Kernel Reference 1-37somUniqueKey FunctionPurposeReturns the unique key associated with a SOM ID.Syntaxunsigned long somUniqueKey (somID id);Desc

iiiPrefaceAbout This BookThis book gives reference material for the System Object Model (SOM) of theSOMobjects Base Toolkit. In particular, it contain

1-38 SOMobjects Base Toolkit: Programmer’s Reference ManualsomVprintf FunctionPurposePrints a formatted string in the manner of the C vprintf function

SOM Kernel Reference 1-39SOMCalloc FunctionPurposeAllocates sufficient zeroed memory for an array of objects of a specified size.SyntaxsomToken (*SOM

1-40 SOMobjects Base Toolkit: Programmer’s Reference ManualSOMClassInitFuncName FunctionPurposeReturns the name of the function used to initialize cla

SOM Kernel Reference 1-41SOMDeleteModule FunctionPurposeUnloads a dynamically linked library (DLL).Syntaxint (*SOMDeleteModule) (somToken modHandle);

1-42 SOMobjects Base Toolkit: Programmer’s Reference ManualSOMError FunctionPurposeHandles an error condition.Syntaxvoid (*SOMError) (int errorCode,

SOM Kernel Reference 1-43SOMFree FunctionPurposeFrees the specified block of memory.Syntaxvoid (*SOMFree) (somToken ptr);DescriptionThe SOMFree funct

1-44 SOMobjects Base Toolkit: Programmer’s Reference ManualSOMInitModule FunctionPurposeInvokes the class creation routines for the classes contained

SOM Kernel Reference 1-45For Windows, also include the following function:#include <windows.h>int CALLBACK LibMain (HINSTANCE inst, WORD ds,

1-46 SOMobjects Base Toolkit: Programmer’s Reference ManualSOMLoadModule FunctionPurposeLoads the dynamically linked library (DLL) containing a SOM cl

SOM Kernel Reference 1-47SOMMalloc FunctionPurposeAllocates the specified amount of memory.SyntaxsomToken (*SOMMalloc) (size_t size);DescriptionThe S

ivSOMobjects Base Toolkit Programmer’s Reference ManualReturn Value A description of the method’s return value.Example An example of using or overridi

1-48 SOMobjects Base Toolkit: Programmer’s Reference ManualSOMOutCharRoutine FunctionPurposePrints a character. This function is replaceable.Syntaxint

SOM Kernel Reference 1-49SOMRealloc FunctionPurposeChanges the size of a previously allocated region of memory.SyntaxsomToken (*SOMRealloc) (somToken

1-50 SOMobjects Base Toolkit: Programmer’s Reference ManualSOM_Assert MacroPurposeAsserts that a boolean condition is true.Syntaxvoid SOM_Assert ( bo

SOM Kernel Reference 1-51SOM_ClassLibrary MacroPurposeIdentifies the file name of the DLL for a SOM class library in a Windows LibMain function.Syntax

1-52 SOMobjects Base Toolkit: Programmer’s Reference ManualSOM_CreateLocalEnvironment MacroPurposeCreates and initializes a local Environment structur

SOM Kernel Reference 1-53SOM_DestroyLocalEnvironment MacroPurposeDestroys a local Environment structure.Syntaxvoid SOM_DestroyLocalEnvironment (Envir

1-54 SOMobjects Base Toolkit: Programmer’s Reference ManualSOM_Error MacroPurposeReports an error condition.Syntaxvoid SOM_Error (long errorCode);Des

SOM Kernel Reference 1-55SOM_Expect MacroPurposeAsserts that a boolean condition is expected to be true.Syntaxvoid SOM_Expect (boolean condition);Des

1-56 SOMobjects Base Toolkit: Programmer’s Reference ManualSOM_GetClass MacroPurposeReturns a pointer to the class object of which a SOM object is an

SOM Kernel Reference 1-57SOM_InitEnvironment MacroPurposeInitializes a local Environment structure.Syntaxvoid SOM_InitEnvironment (Environment * ev);

vPrefaceContentsChapter 1. SOM Kernel Reference 1-1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . somApply Function 1

1-58 SOMobjects Base Toolkit: Programmer’s Reference ManualSOM_MainProgram MacroPurposeIdentifies an application as a SOM program and registers an end

SOM Kernel Reference 1-59SOM_NoTrace MacroPurposeUsed to turn off method debugging.SyntaxSOM_NoTrace (<token> className, <token> methodNam

1-60 SOMobjects Base Toolkit: Programmer’s Reference ManualSOM_ParentNumResolve MacroPurposeObtains a pointer to a method procedure from a list of met

SOM Kernel Reference 1-61SOM_Resolve MacroPurposeObtains a pointer to a static method procedure.SyntaxsomMethodPtr SOM_Resolve (SOMObject objPtr, &l

1-62 SOMobjects Base Toolkit: Programmer’s Reference ManualSOM_ResolveNoCheck MacroPurposeObtains a pointer to a static method procedure, without doin

SOM Kernel Reference 1-63SOM_SubstituteClass MacroPurposeProvides a convenience macro for invoking the somSubstituteClass method.Syntaxlong SOM_Subst

1-64 SOMobjects Base Toolkit: Programmer’s Reference ManualSOM_Test MacroPurposeTests whether a boolean condition is true; if not, a fatal error is ra

SOM Kernel Reference 1-65SOM_TestC MacroPurposeTests whether a boolean condition is true; if not, a warning message is output.Syntaxvoid SOM_TestC (b

1-66 SOMobjects Base Toolkit: Programmer’s Reference ManualSOM_UninitEnvironment MacroPurposeUninitializes a local Environment structure.Syntaxvoid S

SOM Kernel Reference 1-67SOM_WarnMsg MacroPurposeReports a warning message.Syntaxvoid SOM_WarnMsg (string msg);DescriptionIf SOM_WarnLevel is set to

viSOMobjects Base Toolkit Programmer’s Reference ManualSOM_GetClass Macro 1-56. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1-68 SOMobjects Base Toolkit: Programmer’s Reference ManualSOMClass ClassDescriptionSOMClass is the root class for all SOM metaclasses. That is, all S

SOM Kernel Reference 1-69New MethodsAttributes:readonly attribute somOffsets somInstanceDataOffsets_get_somInstanceDataOffsets returns a sequence of s

1-70 SOMobjects Base Toolkit: Programmer’s Reference ManualsomGetNumStaticMethodssomGetParentssomGetVersionNumbersGroup: TestingsomCheckVersionsomDesc

SOM Kernel Reference 1-71somInitClasssomInitMIClasssomOverrideMtabsomOverrideSMethodsomSetClassDatasomSetMethodDescriptor

1-72 SOMobjects Base Toolkit: Programmer’s Reference ManualsomAddDynamicMethod MethodPurposeAdds a new dynamic instance method to a class. Dynamic met

SOM Kernel Reference 1-73C Example/* New dynamic method ”newMethod1” for class ”XXX” */static char *somMN_newMethod1 = ”newMethod1”;static somId somId

1-74 SOMobjects Base Toolkit: Programmer’s Reference ManualsomAllocate MethodPurposeSupports class-specific memory allocation for class instances. Can

SOM Kernel Reference 1-75somCheckVersion MethodPurposeChecks a class for compatibility with the specified major and minor version numbers. Notgenerall

1-76 SOMobjects Base Toolkit: Programmer’s Reference ManualAssuming that the implementation of Animal is version 1.0, this program produces thefollowi

SOM Kernel Reference 1-77somClassReady MethodPurposeIndicates that a class has been constructed and is ready for normal use. Designed to beoverridden.

viiPrefacesomCastObj Method 1-128. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . somDefaultI

1-78 SOMobjects Base Toolkit: Programmer’s Reference ManualsomDeallocate MethodPurposeFrees memory originally allocated by the somAllocate method from

SOM Kernel Reference 1-79somDescendedFrom MethodPurposeTests whether one class is derived from another. Not generally overridden.IDL Syntaxboolean som

1-80 SOMobjects Base Toolkit: Programmer’s Reference ManualsomFindMethod, somFindMethodOk MethodsPurposeFinds the method procedure for a method and in

SOM Kernel Reference 1-81Parametersreceiver A pointer to the class object whose method is desired.methodId An ID that represents the name of the desir

1-82 SOMobjects Base Toolkit: Programmer’s Reference ManualsomFindSMethod, somFindSMethodOk Methods PurposeFinds the method procedure for a static me

SOM Kernel Reference 1-83somGetInstancePartSize MethodPurposeReturns the total size of the instance data structure introduced by a class. Not generall

1-84 SOMobjects Base Toolkit: Programmer’s Reference ManualOriginal ClassSOMClassRelated InformationMethods: somGetInstanceSize

SOM Kernel Reference 1-85somGetInstanceSize MethodPurposeReturns the size of an instance of a class. Not generally overridden.IDL Syntaxlong somGetIns

1-86 SOMobjects Base Toolkit: Programmer’s Reference ManualsomGetInstanceToken MethodPurposeReturns a data access token for the instance data introduc

SOM Kernel Reference 1-87somGetMemberToken MethodPurposeReturns an access token for an instance variable. This is method is not generallyoverridden.ID