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

<!DOCTYPE html> <html lang="en-US"> <head> <title>SOM - Perl extension for access to SOM and DSOM objects. - metacpan.org</title> <link rel="preload" as="fetch" href="/account/login_status" crossorigin="anonymous" /> <link href="/assets/style-XFEQ536G.css" rel="stylesheet" type="text/css"> <script src="/assets/main-WXBSEDQJ.js" type="module"></script> <link rel="alternate" type="application/rss+xml" title="Recent CPAN Uploads of SOM - MetaCPAN" href="/dist/SOM/releases.rss" /> <link rel="canonical" href="https://metacpan.org/pod/SOM" /> <meta name="description" content="Perl extension for access to SOM and DSOM objects." /> <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=5"> <link rel="shortcut icon" href="/static/icons/favicon.ico"> <link rel="apple-touch-icon" sizes="152x152" href="/static/icons/apple-touch-icon.png"> <link rel="search" href="/static/opensearch.xml" type="application/opensearchdescription+xml" title="MetaCPAN"> <script async src="https://perl-ads.perlhacks.com/perl-ads.js"></script> <script async src="https://www.googletagmanager.com/gtag/js?id=G-E82Q2V8LVD"></script> <meta property="og:site_name" content="MetaCPAN" /> <meta name="twitter:site" content="@metacpan" /> <meta property="og:type" content="article" /> <meta name="twitter:card" content="summary" /> <meta property="og:url" content="https://metacpan.org/pod/SOM" /> <meta property="og:title" content="SOM" /> <meta property="og:description" content="Perl extension for access to SOM and DSOM objects." /> <meta property="og:image" content="https://metacpan.org/static/images/dots.png" /> </head> <body> <nav class="navbar navbar-default" role="navigation"> <div class="header-logo-large hidden-xs"> <a href="/" tabindex="0"> <svg class="logo" aria-label="MetaCPAN"> <use class="logo" href="/static/images/metacpan-logo.svg#logo" /> </svg> </a> </div> <div class="header-logo-icon visible-xs"> <a href="/"> <svg class="logo" aria-label="MetaCPAN"> <use class="logo" href="/static/images/metacpan-logo.svg#dots" /> </svg> </a> </div> <ul class="nav navbar-nav menu-items hidden-xs hidden-sm"> <li><a href="/about">About</a></li> <li><a href="/about/sponsors">Sponsor</a></li> <li><a href="https://grep.metacpan.org/">grep::cpan</a></li> <li><a href="/recent">Recent</a></li> <li><a href="/about/faq">FAQ</a></li> <li><a href="/tools">Tools</a></li> <li><a href="https://fastapi.metacpan.org/">API</a></li> </ul> <ul class="nav navbar-nav navbar-right"> <button type="button" class="searchbar-btn visible-xs visible-sm"> <i class="fa fa-search button-fa-icon"></i> </button> <form action="/search" class="searchbar-form visible-md visible-lg search-form form-horizontal"> <input type="hidden" name="size" id="metacpan_search-size" value="20"> <div class="form-group"> <div class="search-group"> <i class="fa fa-search"></i> <input type="text" name="q" placeholder="Search the CPAN" size="41" autocorrect="off" autocapitalize="off" spellcheck="false" id="metacpan_search-input" class="form-control" value=""> </div> </div> </form> <li class="icon-slidepanel visible-xs visible-sm"> <button data-toggle="slidepanel" data-target=".slidepanel"> <span class="button-fa-icon"> <i class="fa fa-bars slidepanel-open"></i> <i class="fa fa-times slidepanel-close"></i> </span> </button> </li> <li class="dropdown login-dropdown show-logged-in"> <button type="button" class="dropdown-toggle" data-toggle="dropdown"> <i class="fa fa-user button-fa-icon logged-in-icon" aria-hidden="true"></i> <i class="fas fa-chevron-down"></i> </button> <ul class="dropdown-menu"> <li><a href="/account/identities">Identities</a></li> <li><a href="/account/profile">Profile</a></li> <li><a href="/account/favorite/list">Favorites</a></li> <li> <a href="#" type="button" class="logout-button"> Logout </a> </li> </ul> </li> <li class="dropdown login-dropdown show-logged-out"> <button type="button" class="dropdown-toggle" data-toggle="dropdown"> <i class="fa fa-user button-fa-icon avatar-placeholder" aria-hidden="true"></i> <i class="fas fa-chevron-down"></i> </button> <ul class="dropdown-menu"> <li> <a href="/login/github"> <i class="fab fa-github fa-fw"></i> GitHub </a> </li> <li> <a href="/login/twitter"> <i class="fab fa-twitter fa-fw"></i> Twitter </a> </li> <li> <a href="/login/google"> <i class="fab fa-google fa-fw"></i> Google </a> </li> </ul> </li> <li class="dropdown login-dropdown hide-logged-in hide-logged-out"> <button> <i class="fa fa-user button-fa-icon" aria-hidden="true"></i> </button> </li> </ul> </nav> <div class="page-content "> <div id="perl-ad-target" class="top-notify-banner perl-ad-target"> </div> <nav class="sidebar"> <div class="slidepanel"> <ul class="nav-list "> <li class="nav-header no-margin-top"> <div class="ttip" data-toggle="tooltip" data-placement="bottom" title="The date that this version of SOM was released."> <span class="relatize">04 Nov 2003 22:02:00 UTC</span> </div> </li> <li> Distribution: <a href="/dist/SOM">SOM</a> </li> <li> Module version: 0.0601 </li> <li> <a data-keyboard-shortcut="g s" href="/dist/SOM/source/SOM.pm">Source</a> (<a href="/dist/SOM/source/SOM.pm?raw=1">raw</a>) </li> <li> <a data-keyboard-shortcut="g b" href="/dist/SOM/source">Browse</a> (<a href="/dist/SOM/source?raw=1">raw</a>) </li> <li> <a data-keyboard-shortcut="g c" href="/dist/SOM/changes">Changes</a> </li> <li> <a class="nopopup" href="/dist/SOM/contribute">How to Contribute</a> </li> <li> <a rel="noopener nofollow" data-keyboard-shortcut="g i" href="https://rt.cpan.org/Public/Dist/Display.html?Name=SOM">Issues</a> </li> <li> <a rel="noopener nofollow" href="http://matrix.cpantesters.org/?dist=SOM+0.0601" title="Matrix">Testers</a> <span title="(pass / fail / na)">(<a rel="noopener nofollow" href="https://www.cpantesters.org/distro/S/SOM.html?oncpan=1&distmat=1&version=0.0601&grade=2" style="color: #090">0</a> / <a rel="noopener nofollow" href="https://www.cpantesters.org/distro/S/SOM.html?oncpan=1&distmat=1&version=0.0601&grade=3" style="color: #900">0</a> / <a rel="noopener nofollow" href="https://www.cpantesters.org/distro/S/SOM.html?oncpan=1&distmat=1&version=0.0601&grade=4">0</a>)</span> </li> <li> <a rel="noopener nofollow" href="http://cpants.cpanauthors.org/release/ILYAZ/SOM-0.0601">Kwalitee</a> </li> <li> <div class="ttip" data-toggle="tooltip" data-placement="bottom" title="The # people with an indexing permission on SOM who have released something to CPAN in the last 2 years (i.e. the # people likely able to release critical fixes in a timely manner)"> Bus factor: 1 </div> </li> <li> License: unknown </li> <li class="nav-header">Activity</li> <li> <div class="activity-graph"> <img src="/dist/SOM/activity.svg?res=month" /> <div class="comment">24 month</div> </div> </li> <li class="nav-header">Tools</li> <li> <a itemprop="downloadUrl" href="https://cpan.metacpan.org/authors/id/I/IL/ILYAZ/modules/SOM-0.0601.zip"> Download (<span itemprop="fileSize">60.41KB</span>)</a> </li> <li> <a href="https://explorer.metacpan.org/?url=%2Fmodule%2FILYAZ%2FSOM-0.0601%2FSOM.pm"> MetaCPAN Explorer </a> </li> <li> <a href="/dist/SOM/permissions"> Permissions </a> </li> <li> <a href="/dist/SOM/releases.rss"> Subscribe to distribution </a> </li> <li> <button class="btn btn-link" data-toggle="modal" data-target="#metacpan_install-instructions-dialog"> Install Instructions </button> </li> <li> <form action="/search"> <input type="hidden" name="q" value="dist:SOM"> <input type="search" name="q" placeholder="Search distribution" class="form-control tool-bar-form"> <input type="submit" style="display: none"> </form> </li> <li> <form action="https://grep.metacpan.org/search"> <input type="hidden" name="qd" value="SOM"> <input type="hidden" name="source" value="metacpan"> <input type="search" name="q" placeholder="grep distribution" class="form-control tool-bar-form"> <input type="submit" style="display: none"> </form> </li> <li class="version-jump"> <select class="select-navigator form-control tool-bar-form"> <option disabled selected>Jump to version</option> <option disabled value="/release/ILYAZ/SOM-0.0601/view/SOM.pm" >0.0601 (ILYAZ on 2003-11-04)</option> <option value="/release/ILYAZ/SOM-0.06/view/SOM.pm" >0.06 (ILYAZ on 2002-05-27)</option> <option value="/release/ILYAZ/SOM-0.03/view/SOM.pm" >0.03 (ILYAZ on 2001-02-26)</option> <option value="/release/ILYAZ/SOM-0.01/view/SOM.pm" >0.01 (ILYAZ on 1999-11-20)</option> </select> </li> <li class="version-diff"> <select class="select-navigator form-control tool-bar-form"> <option disabled selected>Diff with version</option> <option disabled value="/release/ILYAZ/SOM-0.0601/diff/ILYAZ/SOM-0.0601/SOM.pm" >0.0601 (ILYAZ on 2003-11-04)</option> <option value="/release/ILYAZ/SOM-0.0601/diff/ILYAZ/SOM-0.06/SOM.pm" >0.06 (ILYAZ on 2002-05-27)</option> <option value="/release/ILYAZ/SOM-0.0601/diff/ILYAZ/SOM-0.03/SOM.pm" >0.03 (ILYAZ on 2001-02-26)</option> <option value="/release/ILYAZ/SOM-0.0601/diff/ILYAZ/SOM-0.01/SOM.pm" >0.01 (ILYAZ on 1999-11-20)</option> </select> </li> <li> <ul class="dependencies"> <li class="nav-header">Dependencies</li> <li><i class="ttip" title="dynamic_config enabled">unknown</i></li> <li> <hr> </li> <li> <a href="/module/SOM/requires">Reverse dependencies</a> </li> <li> <a href="http://deps.cpantesters.org/?module=SOM">CPAN Testers List</a> </li> <li> <a href="https://cpandeps.grinnz.com/?dist=SOM">Dependency graph</a> </li> </ul> </li> <li class="nav-header">Permalinks</li> <li> <a href="/release/ILYAZ/SOM-0.0601/view/SOM.pm">This version</a> </li> <li> <a href="/pod/SOM">Latest version</a> </li> <li> </li> <li> </li> </ul> </div> </nav> <div class="content-navigation"> <div class="breadcrumbs"> <span> <a data-keyboard-shortcut="g a" rel="author" href="/author/ILYAZ" class="author-name">Ilya Zakharevich</a> </span> <span> / </span> <div class="release dist-release status-latest maturity-released"> <span class="dropdown"><b class="caret"></b></span> <select class="select-navigator "> <option selected value="/release/ILYAZ/SOM-0.0601/view/SOM.pm" >0.0601 (ILYAZ on 2003-11-04)</option> <option value="/release/ILYAZ/SOM-0.06/view/SOM.pm" >0.06 (ILYAZ on 2002-05-27)</option> <option value="/release/ILYAZ/SOM-0.03/view/SOM.pm" >0.03 (ILYAZ on 2001-02-26)</option> <option value="/release/ILYAZ/SOM-0.01/view/SOM.pm" >0.01 (ILYAZ on 1999-11-20)</option> </select> <a data-keyboard-shortcut="g d" class="release-name" href="/dist/SOM">SOM-0.0601</a> </div> <span class="river-gauge-gauge"> <svg width="24px" height="15px" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"> <g> <title> River stage zero 
 No dependents </title> <rect x="0" y="0" width="4" height="15" fill="#e4e2e2" /> <rect x="5" y="0" width="4" height="15" fill="#e4e2e2" /> <rect x="10" y="0" width="4" height="15" fill="#e4e2e2" /> <rect x="15" y="0" width="4" height="15" fill="#e4e2e2" /> <rect x="20" y="0" width="4" height="15" fill="#e4e2e2" /> </g> </svg> </span> <div id="SOM-fav" class="show-logged-in"> <form action="/account/favorite/add" style="display: inline" method="POST"> <input type="hidden" name="remove" value="0"> <input type="hidden" name="release" value="SOM-0.0601"> <input type="hidden" name="author" value="ILYAZ"> <input type="hidden" name="distribution" value="SOM"> <button type="submit" class="favorite"><span></span> ++</button> </form> </div> <div class="show-logged-out"> <button class="fav-not-logged-in favorite"><span></span> ++</button> </div> / <span>SOM</span> </div> </div> <main class="content"> <nav class="toc"> <div class="toc-header"><strong>Contents</strong></div> <ul> <li><a href="#NAME">NAME</a></li> <li><a href="#SYNOPSIS">SYNOPSIS</a></li> <li><a href="#DESCRIPTION">DESCRIPTION</a> <ul> <li><a href="#Supported-types">Supported types</a></li> <li><a href="#Supported-services">Supported services</a></li> </ul> </li> <li><a href="#Primitive-classes">Primitive classes</a> <ul> <li><a href="#SOMObjectPtr">SOMObjectPtr</a></li> <li><a href="#SOMClassPtr">SOMClassPtr</a></li> <li><a href="#ContainedPtr">ContainedPtr</a></li> <li><a href="#ContainerPtr">ContainerPtr</a></li> <li><a href="#AttributeDescriptionPtr">AttributeDescriptionPtr</a></li> <li><a href="#OperationPtr">OperationPtr</a></li> <li><a href="#ParameterPtr">ParameterPtr</a></li> <li><a href="#TypeCode">TypeCode</a></li> <li><a href="#any">any</a></li> </ul> </li> <li><a href="#Repository">Repository</a> <ul> <li><a href="#BUGS">BUGS</a></li> </ul> </li> <li><a href="#Working-with-DSOM">Working with DSOM</a> <ul> <li><a href="#Starting%2Fstopping-servers">Starting/stopping servers</a></li> <li><a href="#Class-EnvironmentPtr">Class EnvironmentPtr</a></li> <li><a href="#Package-SOM%3A%3ASOMDeamon">Package SOM::SOMDeamon</a></li> <li><a href="#Class-SOMClassManagerPtr">Class SOMClassManagerPtr</a></li> <li><a href="#Class-ObjectMgrPtr">Class ObjectMgrPtr</a></li> <li><a href="#Class-SOMDObjectMgrPtr">Class SOMDObjectMgrPtr</a></li> <li><a href="#Class-SOMDServerPtr">Class SOMDServerPtr</a></li> <li><a href="#Example">Example</a></li> </ul> </li> <li><a href="#EXPORT">EXPORT</a></li> <li><a href="#AUTHOR">AUTHOR</a></li> <li><a href="#BUGS1">BUGS</a></li> <li><a href="#SEE-ALSO">SEE ALSO</a></li> </ul></nav> <div class="pod anchors"> <h1 id="NAME">NAME</h1> <p>SOM - Perl extension for access to SOM and DSOM objects.</p> <h1 id="SYNOPSIS">SYNOPSIS</h1> <pre><code>use SOM; blah blah blah</code></pre> <h1 id="DESCRIPTION">DESCRIPTION</h1> <h2 id="Supported-types"><a id="Supported"></a>Supported types</h2> <p>(exported with the tag <code>:types</code>):</p> <pre><code>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</code></pre> <h2 id="Supported-services"><a id="Supported1"></a>Supported services</h2> <pre><code>$class = Find_Class($classname, $major, $minor)</code></pre> <p>Returns SOM Class object. Use <code>$major = $minor = 0</code> if you do not need a version check.</p> <pre><code>$obj = $class->NewObject()</code></pre> <p>Creates a new instance of an object of the given class.</p> <pre><code>$repo = RepositoryNew()</code></pre> <p>Returns an object for access to Repository.</p> <pre><code>SOMClass()</code></pre> <p>Returns the SOM (meta)class <code>SOMClass</code>.</p> <pre><code>SOMObject()</code></pre> <p>Returns the SOM class <code>SOMObject</code>.</p> <pre><code>SOMClassMgr()</code></pre> <p>Returns the SOM class <code>SOMClassMgr</code>.</p> <pre><code>SOMClassMgrObject()</code></pre> <p>Returns the standard <code>SOMClassMgrObject</code> object.</p> <pre><code>$obj->Dispatch0($method_name)</code></pre> <p>Dispatches a method with void return and no arguments (not supported, fatal error if $method_name cannot be resolved).</p> <pre><code>$obj->Dispatch_templ($method_name, $template, ...)</code></pre> <p>Dispatches a method with return type and arguments described by a $template. See <i>t/animal.t</i> how to build a template.</p> <pre><code>$obj->GetClass()</code></pre> <p>Return the class of the object (as a SOM object).</p> <h1 id="Primitive-classes"><a id="Primitive"></a>Primitive classes</h1> <p>Some SOM methods are hardwired into the module, they operate on Perl objects with names ending on <code>Ptr</code>. (Other SOM methods are currently supported with Dispatch_templ() method only.)</p> <p>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.</p> <p>DSOM-related primitive classes are listed in <a href="#Working-with-DSOM">"Working with DSOM"</a>.</p> <h2 id="SOMObjectPtr">SOMObjectPtr</h2> <dl> <dt id="GetClass"><code>GetClass</code></dt> <dd> <p>Returns the class object.</p> </dd> <dt id="GetClassName"><code>GetClassName</code></dt> <dd> <p>Returns the class name.</p> </dd> </dl> <p>Additionally, two non-SOM methods are made available: Dispatch0() and Dispatch_templ().</p> <h2 id="SOMClassPtr">SOMClassPtr</h2> <dl> <dt id="NewObject"><code>NewObject</code></dt> <dd> <p>Returns a new object of the given class.</p> </dd> </dl> <h2 id="ContainedPtr">ContainedPtr</h2> <p>All the methods take environment as an argument:</p> <pre><code>$name = $obj->name($env)</code></pre> <dl> <dt id="name"><code>name</code></dt> <dd> <p>String name of the element (unique inside the immediate parent).</p> </dd> <dt id="id"><code>id</code></dt> <dd> <p>String id of the element (unique in the repository).</p> </dd> <dt id="defined_in"><code>defined_in</code></dt> <dd> <p>String id of the immediate parent.</p> </dd> <dt id="within"><code>within</code></dt> <dd> <p>Returns a list of containers with definitions of this object.</p> </dd> <dt id="describe"><code>describe</code></dt> <dd> <p>Returns information defined in the IDL specification of this object. <b>Memory management for this???</b>. Return type is <code>AttributeDescriptionPtr</code>.</p> </dd> </dl> <h2 id="ContainerPtr">ContainerPtr</h2> <dl> <dt id="lookup_name"><code>lookup_name</code></dt> <dd> <p>Returns a list of objects with the given name within a specified Container object, or within objects contained in the Container object.</p> <pre><code>$obj->lookup_name($env, $name, $levels, $type, $noinherited)</code></pre> <p>$levels should be -1 to search all the kids-containers as well, otherwise should be 1. $type should be one of</p> <pre><code>AttributeDef ConstantDef ExceptionDef InterfaceDef ModuleDef ParameterDef OperationDef TypeDef all</code></pre> <p>If $noinherited, any inherited objects will not be returned.</p> </dd> <dt id="contents"><code>contents</code></dt> <dd> <p>Returns the list of contained elements.</p> <pre><code>$obj->contents($env, $type, $noinherited)</code></pre> <p>Parameters have the same sense as for the <code>lookup_name</code> method.</p> </dd> </dl> <h2 id="AttributeDescriptionPtr">AttributeDescriptionPtr</h2> <p><b>Should be scraped: AttributeDescriptionPtr should be substituted by proper subclass of Contained!</b></p> <p>The methods do not take environment as an argument:</p> <pre><code>$typecode = $attr->type()</code></pre> <p>In addition to methods name(), id(), defined_in() similar to ones in <code>Contained</code>, has two additional methods:</p> <dl> <dt id="type">type</dt> <dd> <p><code>TypeCodePtr</code> object which describes the type of the attribute.</p> </dd> <dt id="readonly">readonly</dt> <dd> <p>whether the attribute is readonly.</p> </dd> </dl> <p>Currently there is no value() method.</p> <h2 id="OperationPtr">OperationPtr</h2> <p>All the methods take environment as an argument:</p> <pre><code>$name = $op->result($env)</code></pre> <dl> <dt id="result"><code>result</code></dt> <dd> <p><code>TypeCode</code> of the return value.</p> </dd> </dl> <h2 id="ParameterPtr">ParameterPtr</h2> <p>All the methods take environment as an argument:</p> <pre><code>$name = $argN->type($env)</code></pre> <dl> <dt id="type1"><code>type</code></dt> <dd> <p><code>TypeCode</code> of this argument.</p> </dd> <dt id="mode"><code>mode</code></dt> <dd> <p>One of the strings <code>INOUT</code>, <code>OUT</code>, <code>IN</code>.</p> </dd> </dl> <h2 id="TypeCode">TypeCode</h2> <p>All the methods take environment as an argument:</p> <pre><code>$kind = $tc->kind($env)</code></pre> <dl> <dt id="kind"><code>kind</code></dt> <dd> <p>Returns the type of the TypeCode. Types are the same as <a href="#Supported-types">"Supported types"</a>.</p> </dd> <dt id="param_count"><code>param_count</code></dt> <dd> <p>Returns the number of parameters encoded in the TypeCode.</p> </dd> <dt id="parameter"><code>parameter</code></dt> <dd> <p>Returns the <i>n</i>th parameter encoded in the TypeCode as <code>any</code>. <i>n</i> changes from 0 to <i>param_count</i><code> - 1</code>.</p> <pre><code>$p = $tc->parameter($env, 2);</code></pre> </dd> </dl> <h2 id="any">any</h2> <p>All the methods take environment as an argument:</p> <pre><code>$type = $any->type($env)</code></pre> <dl> <dt id="type2"><code>type</code></dt> <dd> <p>Returns the <code>TypeCode</code> of the value stored in the <code>any</code>.</p> </dd> <dt id="value"><code>value</code></dt> <dd> <p>Returns the value stored in the <code>any</code>. Only elementary types are supported now.</p> </dd> </dl> <h1 id="Repository">Repository</h1> <p>Since <code>Container</code>/<code>Contained</code> 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 <code>InterfaceDef</code> elements (which carry information about SOM classes), inside an <code>InterfaceDef</code> we look for <code>OperationDef</code> elements (which correspond to methods in the class), and inside an <code>OperationDef</code> we look for <code>ParameterDef</code> elements (which correspond to arguments of a method).</p> <h2 id="BUGS">BUGS</h2> <p>We consider <code>ContainedContainerPtr</code> as being both a <code>ContainerPtr</code> and <code>ContainedPtr</code>. But not all of them are. This is bad, since calling C SOM bindings on an object of unappropriate type is not catchable.</p> <h1 id="Working-with-DSOM"><a id="Working"></a>Working with DSOM</h1> <p>After any call which includes $ev, one should <code>$ev-</code>Clear> to avoid memory leaks. Before this call $ev can be expected for error info. Package SOM contains following <i>major codes</i> of exceptions: SYSTEM_EXCEPTION, USER_EXCEPTION, NO_EXCEPTION (exportable with tag <code>:environment</code>).</p> <p>This API is very experimental. Read DSOM reference to know what these calls are doing.</p> <h2 id="Starting/stopping-servers"><a id="Starting"></a><a id="Starting-stopping-servers"></a>Starting/stopping servers</h2> <p>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 <code>:dsom</code>).</p> <p>To create: <code>SOM::RestartSOMDD(1)</code>, <code>SOM::RestartWPDServer(1)</code>.</p> <p>To stop: <code>SOM::RestartSOMDD(0)</code>, <code>SOM::RestartWPDServer(0)</code>.</p> <p>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).</p> <p>Additionally, stopping servers when they did not completely started could lead to problems.</p> <p>A convenience function <code>SOM::Ensure_Servers($shutdown_dsom, $shutdown_wpsd)</code> 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 <code>:dsom</code>)</p> <h2 id="Class-EnvironmentPtr"><a id="Class"></a>Class <code>EnvironmentPtr</code></h2> <p>To create:</p> <pre><code>$ev = SOM::CreateLocalEnvironment();</code></pre> <p>(exportable with tag <code>:environment</code>).</p> <p>Methods:</p> <pre><code> $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</code></pre> <p>A simpleminded error reporter is made available as method <code>Check</code>:</p> <pre><code>$err = $ev->Check and warn "Got exception $err";</code></pre> <p>$err is formatted as <code>MAJOR=2 ID='OPSYS' MINOR=343 COMPLETED=NO</code>.</p> <h2 id="Package-SOM::SOMDeamon"><a id="Package"></a>Package <code>SOM::SOMDeamon</code></h2> <p>Functions:</p> <pre><code>Init($ev); Uninit($ev); ClassMgrObject(); # Default SOMD class manager ObjectMgr(); # Default SOMD object manager WPClassManagerNew(); # One can Merge the result with ObjectMgr()</code></pre> <h2 id="Class-SOMClassManagerPtr"><a id="Class1"></a>Class <code>SOMClassManagerPtr</code></h2> <p>Methods:</p> <pre><code>$oldmgr->MergeInto($newmgr);</code></pre> <h2 id="Class-ObjectMgrPtr"><a id="Class2"></a>Class <code>ObjectMgrPtr</code></h2> <p>Methods:</p> <pre><code>$mgr->ReleaseObject($ev, $servername);</code></pre> <h2 id="Class-SOMDObjectMgrPtr"><a id="Class3"></a>Class <code>SOMDObjectMgrPtr</code></h2> <p>ISA <code>ObjectMgrPtr</code>.</p> <p>Methods:</p> <pre><code>$server = $mgr->FindServerByName($ev, $servername);</code></pre> <h2 id="Class-SOMDServerPtr"><a id="Class4"></a>Class <code>SOMDServerPtr</code></h2> <p>Methods:</p> <pre><code>$server->GetClassObj($ev, $classname);</code></pre> <h2 id="Example">Example</h2> <p>Initialize:</p> <pre><code>use SOM ':class', ':dsom', ':environment'; Ensure_Servers(); $ev = SOM::CreateLocalEnvironment(); sub EnvironmentPtr::CheckAndWarn { my $err; $err = $ev->Check and warn "Got exception $err"; }</code></pre> <p>Start class dispatchers:</p> <pre><code>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;</code></pre> <p>Get a class object of requested type:</p> <pre><code>$classFolder = $server->GetClassObj($ev, "WPFolder") or die; $ev->CheckAndWarn; ## ... Do some work with $folderClass</code></pre> <p>Shut down dispatchers:</p> <pre><code>SOM::SOMDeamon::ObjectMgr->ReleaseObject($ev, $server); $ev->CheckAndWarn; SOM::SOMDeamon::Uninit($ev); $ev->CheckAndWarn;</code></pre> <h1 id="EXPORT">EXPORT</h1> <p>None by default. Tags <code>:types</code>, <code>:class</code>, <code>:dsom</code>, <code>:environment</code>.</p> <h1 id="AUTHOR">AUTHOR</h1> <p>A. U. Thor, a.u.thor@a.galaxy.far.far.away</p> <h1 id="BUGS1">BUGS</h1> <p>Only primitive types of parameters and return value are supported.</p> <p>Only in-parameters are supported.</p> <p>No memory management is done at all.</p> <p>Exception is not analysed.</p> <p>SOM Objects have type SOMObjectPtr, SOM Classes have type SOMClassPtr etc.</p> <p>Methods may be dispatched only when a signature is explicitely described.</p> <h1 id="SEE-ALSO"><a id="SEE"></a>SEE ALSO</h1> <p>perl(1).</p></div> <div id="metacpan_install-instructions-dialog" class="modal fade"> <div class="modal-dialog"> <div class="modal-content"> <div class="modal-header"> <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button> <h4 class="modal-title">Module Install Instructions</h4> </div> <div class="modal-body"> <p>To install SOM, copy and paste the appropriate command in to your terminal.</p> <p><a href="/dist/App-cpanminus/view/bin/cpanm">cpanm</a></p> <pre><code>cpanm SOM</code></pre> <p><a href="/pod/CPAN">CPAN shell</a></p> <pre><code>perl -MCPAN -e shell install SOM</code></pre> <p>For more information on module installation, please visit <a href="https://www.cpan.org/modules/INSTALL.html">the detailed CPAN module installation guide</a>.</p> </div> <div class="modal-footer"> <a href="#" data-dismiss="modal" class="btn">Close</a> </div> </div> </div> </div> </main> <div class="content-pagination"> </div> </div> <footer class="footer"> <div class="footer-container"> <div class="footer-social"> <div class="footer-link footer-logo"> <a href="/"> <img src="/static/images/metacpan-logo.svg" alt="MetaCPAN" /> </a> </div> <a class="footer-social-link" href="https://github.com/metacpan"> <i class="fab fa-github-square"></i> </a> <a class="footer-social-link" href="https://fosstodon.org/@metacpan"> <i class="fab fa-mastodon"></i> </a> </div> <div class="footer-links"> <div class="footer-link"> <a href="/about">About</a> </div> <div class="footer-link"> <a href="/about/sponsors">Sponsor</a> </div> <div class="footer-link"> <a href="https://grep.metacpan.org">grep::cpan</a> </div> <div class="footer-link"> <a href="/recent">Recent</a> </div> <div class="footer-link"> <a href="/about/faq">FAQ</a> </div> <div class="footer-link"> <a href="/tools">Tools</a> </div> <div class="footer-link"> <a href="https://fastapi.metacpan.org/">API</a> </div> <div class="footer-link"> <a href="https://www.perl.org/">Perl.org</a> </div> </div> <div class="footer-sponsors"> <a class="footer-sponsor-link" target="_blank" href="https://www.bytemark.co.uk/" rel="noopener"> <img class="footer-sponsor-bytemark" src="/static/images/sponsors/bytemark_logo.svg" alt="Bytemark logo"> </a> <a class="footer-sponsor-link" target="_blank" href="https://www.liquidweb.com/" rel="noopener"> <img class="footer-sponsor-liquidweb" src="/static/images/sponsors/liquidweb_logo.png" alt="liquidweb logo"> </a> <a class="footer-sponsor-link" target="_blank" href="https://deriv.com/careers/" rel="noopener"> <img class="footer-sponsor-deriv" src="/static/images/sponsors/deriv.svg" alt="Deriv logo"> </a> <a class="footer-sponsor-link" target="_blank" href="https://geocode.xyz" rel="noopener"> <img class="footer-sponsor-geocode" src="/static/images/sponsors/geocodelogo.svg" alt="Geocode logo"> </a> <a class="footer-sponsor-link" target="_blank" href="https://www.fastly.com/" rel="noopener"> <img class="footer-sponsor-fastly" src="/static/images/sponsors/fastly_logo.svg" alt="Fastly logo"> </a> <a class="footer-sponsor-link" target="_blank" href="https://opencagedata.com" rel="noopener"> <img class="footer-sponsor-opencage" src="/static/images/sponsors/open-cage.svg" alt="OpenCage logo"> </a>  <a class="footer-sponsor-link" target="_blank" href="https://www.elastic.co/" rel="noopener"> <img class="footer-sponsor-elastic" src="/static/images/sponsors/elastic.svg" alt="Elastic logo"> </a>  <a class="footer-sponsor-link" target="_blank" href="https://route4me.com/" rel="noopener"> <img class="footer-sponsor-route4me" src="/static/images/sponsors/route4me.png" alt="Route4Me logo"> </a> </div> </div> </footer> <div class="modal fade" tabindex="-1" role="dialog" id="metacpan_keyboard-shortcuts"> <div class="modal-dialog"> <div class="modal-content"> <div class="modal-header"> <button type="button" class="close" data-dismiss="modal">×</button> <h4 class="modal-title">Keyboard Shortcuts</h4> </div> <div class="modal-body row"> <div class="col-md-6"> <table class="table keyboard-shortcuts"> <thead> <tr> <th></th> <th>Global</th> </tr> </thead> <tbody> <tr> <td class="keys"> <kbd>s</kbd> </td> <td>Focus search bar</td> </tr> <tr> <td class="keys"> <kbd>?</kbd> </td> <td>Bring up this help dialog</td> </tr> </tbody> </table> <table class="table keyboard-shortcuts"> <thead> <tr> <th></th> <th>GitHub</th> </tr> </thead> <tbody> <tr> <td class="keys"> <kbd>g</kbd> <kbd>p</kbd> </td> <td>Go to pull requests</td> </tr> <tr> <td class="keys"> <kbd>g</kbd> <kbd>i</kbd> </td> <td>go to github issues (only if github is preferred repository)</td> </tr> </tbody> </table> </div> <div class="col-md-6"> <table class="table keyboard-shortcuts"> <thead> <tr> <th></th> <th>POD</th> </tr> </thead> <tbody> <tr> <td class="keys"> <kbd>g</kbd> <kbd>a</kbd> </td> <td>Go to author</td> </tr> <tr> <td class="keys"> <kbd>g</kbd> <kbd>c</kbd> </td> <td>Go to changes</td> </tr> <tr> <td class="keys"> <kbd>g</kbd> <kbd>i</kbd> </td> <td>Go to issues</td> </tr> <tr> <td class="keys"> <kbd>g</kbd> <kbd>d</kbd> </td> <td>Go to dist</td> </tr> <tr> <td class="keys"> <kbd>g</kbd> <kbd>r</kbd> </td> <td>Go to repository/SCM</td> </tr> <tr> <td class="keys"> <kbd>g</kbd> <kbd>s</kbd> </td> <td>Go to source</td> </tr> <tr> <td class="keys"> <kbd>g</kbd> <kbd>b</kbd> </td> <td>Go to file browse</td> </tr> </tbody> </table> </div> <div class="col-md-12"> <table class="table keyboard-shortcuts"> <thead> <tr> <th></th> <th>Search terms</th> </tr> </thead> <tbody> <tr> <td><em>module:</em> (e.g. <a href="/search?q=module%3APlugin">module:Plugin</a>)</td> </tr> <tr> <td><em>distribution:</em> (e.g. <a href="/search?q=distribution%3ADancer+auth">distribution:Dancer auth</a>)</td> </tr> <tr> <td><em>author:</em> (e.g. <a href="/search?q=author%3ASONGMU+Redis">author:SONGMU Redis</a>)</td> </tr> <tr> <td><em>version:</em> (e.g. <a href="/search?q=version%3A1.00">version:1.00</a>)</td> </tr> </tbody> </table> </div> </div> <div class="modal-footer"></div> </div> </div> </div> </body> </html>

CINXE.COM

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