NAME

SOM - Perl extension for access to SOM and DSOM objects.

SYNOPSIS

use SOM;
blah blah blah

DESCRIPTION

Supported types

(exported with the tag :types):

tk_short
tk_ushort
tk_long
tk_ulong
tk_float
tk_double
tk_char
tk_boolean
tk_octet
tk_enum
tk_string
tk_objref
tk_pointer		# Not yet?
tk_void		# Output only

Supported services

$class = Find_Class($classname, $major, $minor)

Returns SOM Class object. Use $major = $minor = 0 if you do not need a version check.

$obj = $class->NewObject()

Creates a new instance of an object of the given class.

$repo = RepositoryNew()

Returns an object for access to Repository.

SOMClass()

Returns the SOM (meta)class SOMClass.

SOMObject()

Returns the SOM class SOMObject.

SOMClassMgr()

Returns the SOM class SOMClassMgr.

SOMClassMgrObject()

Returns the standard SOMClassMgrObject object.

$obj->Dispatch0($method_name)

Dispatches a method with void return and no arguments (not supported, fatal error if $method_name cannot be resolved).

$obj->Dispatch_templ($method_name, $template, ...)

Dispatches a method with return type and arguments described by a $template. See t/animal.t how to build a template.

$obj->GetClass()

Return the class of the object (as a SOM object).

Primitive classes

Some SOM methods are hardwired into the module, they operate on Perl objects with names ending on Ptr. (Other SOM methods are currently supported with Dispatch_templ() method only.)

Note that support of Repository classes is much more complete than for other classes, since support on auto-import of methods is impossible without this.

DSOM-related primitive classes are listed in "Working with DSOM".

SOMObjectPtr

GetClass: Returns the class object.
GetClassName: Returns the class name.

Additionally, two non-SOM methods are made available: Dispatch0() and Dispatch_templ().

SOMClassPtr

NewObject: Returns a new object of the given class.

ContainedPtr

All the methods take environment as an argument:

$name = $obj->name($env)

name: String name of the element (unique inside the immediate parent).
id: String id of the element (unique in the repository).
defined_in: String id of the immediate parent.
within: Returns a list of containers with definitions of this object.
describe: Returns information defined in the IDL specification of this object. Memory management for this???. Return type is AttributeDescriptionPtr.

ContainerPtr

lookup_name

Returns a list of objects with the given name within a specified Container object, or within objects contained in the Container object.

$obj->lookup_name($env, $name, $levels, $type, $noinherited)

$levels should be -1 to search all the kids-containers as well, otherwise should be 1. $type should be one of

AttributeDef ConstantDef ExceptionDef InterfaceDef
ModuleDef ParameterDef OperationDef TypeDef all

If $noinherited, any inherited objects will not be returned.

contents

Returns the list of contained elements.

$obj->contents($env, $type, $noinherited)

Parameters have the same sense as for the lookup_name method.

AttributeDescriptionPtr

Should be scraped: AttributeDescriptionPtr should be substituted by proper subclass of Contained!

The methods do not take environment as an argument:

$typecode = $attr->type()

In addition to methods name(), id(), defined_in() similar to ones in Contained, has two additional methods:

type: TypeCodePtr object which describes the type of the attribute.
readonly: whether the attribute is readonly.

Currently there is no value() method.

OperationPtr

All the methods take environment as an argument:

$name = $op->result($env)

result: TypeCode of the return value.

ParameterPtr

All the methods take environment as an argument:

$name = $argN->type($env)

type: TypeCode of this argument.
mode: One of the strings INOUT, OUT, IN.

TypeCode

All the methods take environment as an argument:

$kind = $tc->kind($env)

kind

Returns the type of the TypeCode. Types are the same as "Supported types".

param_count

Returns the number of parameters encoded in the TypeCode.

parameter

Returns the nth parameter encoded in the TypeCode as any. n changes from 0 to param_count - 1.

$p = $tc->parameter($env, 2);

any

All the methods take environment as an argument:

$type = $any->type($env)

type: Returns the TypeCode of the value stored in the any.
value: Returns the value stored in the any. Only elementary types are supported now.

Repository

Since Container/Contained are completely supported by primitive classes, one can walk the Repository tree any way one is pleased. We use only the following subtree of the Repository: inside toplevel we find InterfaceDef elements (which carry information about SOM classes), inside an InterfaceDef we look for OperationDef elements (which correspond to methods in the class), and inside an OperationDef we look for ParameterDef elements (which correspond to arguments of a method).

BUGS

We consider ContainedContainerPtr as being both a ContainerPtr and ContainedPtr. But not all of them are. This is bad, since calling C SOM bindings on an object of unappropriate type is not catchable.

Working with DSOM

After any call which includes $ev, one should $ev-Clear> to avoid memory leaks. Before this call $ev can be expected for error info. Package SOM contains following major codes of exceptions: SYSTEM_EXCEPTION, USER_EXCEPTION, NO_EXCEPTION (exportable with tag :environment).

This API is very experimental. Read DSOM reference to know what these calls are doing.

Starting/stopping servers

DSOM to WPS requires two servers: one is a SOMD server (a separate process), another is WPSD server (extra thread(s) in WPS shell process). To check existence: SOM::IsSOMDDReady(), SOM::IsWPDServerReady(). Possible error codes in $^E: PMERR_WPDSERVER_IS_ACTIVE(), PMERR_WPDSERVER_NOT_STARTED(), PMERR_SOMDD_IS_ACTIVE(), PMERR_SOMDD_NOT_STARTED() (all in package SOM, exportable on :dsom).

To create: SOM::RestartSOMDD(1), SOM::RestartWPDServer(1).

To stop: SOM::RestartSOMDD(0), SOM::RestartWPDServer(0).

Keep in mind that servers are not refcounted, so it maybe not a very good idea to shut them down even if did not run when you started (since somebody else could have started to use them in between).

Additionally, stopping servers when they did not completely started could lead to problems.

A convenience function SOM::Ensure_Servers($shutdown_dsom, $shutdown_wpsd) is provided. If the arguments are given, servers will be shutdown at end of run if they were not running when this function was called. (Exportable with :dsom)

Class `EnvironmentPtr`

To create:

$ev = SOM::CreateLocalEnvironment();

(exportable with tag :environment).

Methods:

  $major = $ev->major;
  $stringID = $ev->id;
  $minor = $ev->id;		# 0 if $ev->major != SYSTEM_EXCEPTION
  $state = $ev->completed;	# undef if $ev->major != SYSTEM_EXCEPTION
				# or state is not YES or NO, otherwise 0 or 1
  $ev->Clear;			# Free() data if $ev->major == SYSTEM_EXCEPTION

A simpleminded error reporter is made available as method Check:

$err = $ev->Check and warn "Got exception $err";

$err is formatted as MAJOR=2 ID='OPSYS' MINOR=343 COMPLETED=NO.

Package `SOM::SOMDeamon`

Functions:

Init($ev);
Uninit($ev);
ClassMgrObject();		# Default SOMD class manager
ObjectMgr();			# Default SOMD object manager
WPClassManagerNew();		# One can Merge the result with ObjectMgr()

Class `SOMClassManagerPtr`

Methods:

$oldmgr->MergeInto($newmgr);

Class `ObjectMgrPtr`

Methods:

$mgr->ReleaseObject($ev, $servername);

Class `SOMDObjectMgrPtr`

ISA ObjectMgrPtr.

Methods:

$server = $mgr->FindServerByName($ev, $servername);

Class `SOMDServerPtr`

Methods:

$server->GetClassObj($ev, $classname);

Example

Initialize:

use SOM ':class', ':dsom', ':environment';
Ensure_Servers();
$ev = SOM::CreateLocalEnvironment();

sub EnvironmentPtr::CheckAndWarn {
  my $err; $err = $ev->Check and warn "Got exception $err";
}

Start class dispatchers:

SOM::SOMDeamon::Init($ev);
$ev->CheckAndWarn;
$SOM_ClassMgr = SOM::SOMDeamon::ClassMgrObject or die;
$WPS_ClassMgr = SOM::SOMDeamon::WPClassManagerNew or die;
$SOM_ClassMgr->MergeInto($WPS_ClassMgr); # In fact MergeFrom

Init_WP_Classes();	# Otherwise cannot GetClassObj('WPFolder')

$server = SOM::SOMDeamon::ObjectMgr->FindServerByName($ev, "wpdServer")
  or die;
$ev->CheckAndWarn;

Get a class object of requested type:

$classFolder = $server->GetClassObj($ev, "WPFolder") or die;
$ev->CheckAndWarn;
## ... Do some work with $folderClass

Shut down dispatchers:

SOM::SOMDeamon::ObjectMgr->ReleaseObject($ev, $server);
$ev->CheckAndWarn;
SOM::SOMDeamon::Uninit($ev);
$ev->CheckAndWarn;

EXPORT

None by default. Tags :types, :class, :dsom, :environment.

AUTHOR

A. U. Thor, a.u.thor@a.galaxy.far.far.away

BUGS

Only primitive types of parameters and return value are supported.

Only in-parameters are supported.

No memory management is done at all.

Exception is not analysed.

SOM Objects have type SOMObjectPtr, SOM Classes have type SOMClassPtr etc.

Methods may be dispatched only when a signature is explicitely described.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

SYNOPSIS

DESCRIPTION

Supported types

Supported services

Primitive classes

SOMObjectPtr

SOMClassPtr

ContainedPtr

ContainerPtr

AttributeDescriptionPtr

OperationPtr

ParameterPtr

TypeCode

any

Repository

BUGS

Working with DSOM

Starting/stopping servers

Class EnvironmentPtr

Package SOM::SOMDeamon

Class SOMClassManagerPtr

Class ObjectMgrPtr

Class SOMDObjectMgrPtr

Class SOMDServerPtr

Example

EXPORT

AUTHOR

BUGS

SEE ALSO

Module Install Instructions

Class `EnvironmentPtr`

Package `SOM::SOMDeamon`

Class `SOMClassManagerPtr`

Class `ObjectMgrPtr`

Class `SOMDObjectMgrPtr`

Class `SOMDServerPtr`