From 6bcdad20c24457393c0d9eeb385d0ff5aa872cd0 Mon Sep 17 00:00:00 2001 From: Lars Thorsen Date: Wed, 25 Apr 2018 15:09:14 +0200 Subject: Move the corba applcations to separate repository All corba applications are moved to a separate repository. E.g. orber, ic, cosEvent, cosEventDomain, cosNotifications cosTime, cosTransactions, cosProperty and cosFileTransfer. --- lib/orber/doc/src/corba_object.xml | 194 ------------------------------------- 1 file changed, 194 deletions(-) delete mode 100644 lib/orber/doc/src/corba_object.xml (limited to 'lib/orber/doc/src/corba_object.xml') diff --git a/lib/orber/doc/src/corba_object.xml b/lib/orber/doc/src/corba_object.xml deleted file mode 100644 index 09a4b0bc3c..0000000000 --- a/lib/orber/doc/src/corba_object.xml +++ /dev/null @@ -1,194 +0,0 @@ - - - - -
- - 1997 - 2016 - Ericsson AB, All Rights Reserved - - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - The Initial Developer of the Original Code is Ericsson AB. - - - corba_object - - - - - - 1997-11-10 - A -
- corba_object - The CORBA Object interface functions - -

This module contains the CORBA Object interface functions that can be - called for all objects.

- - - - get_interface(Object) -> InterfaceDef - Fetch the interface description - - Object = #objref - InterfaceDef = term() - - -

This function returns the full interface description for an object.

- - - - is_nil(Object) -> boolean() - Return true, if the given object is a NIL object reference, otherwise false - - Object = #objref - - -

This function checks if the object reference has a nil object value, - which denotes no object. It is the reference that is tested and no - object implementation is involved in the test.

- - - - is_a(Object, Logical_type_id) -> Return - is_a(Object, Logical_type_id, Contexts) -> Return - Return true if the target object is an, or inherit from, object of the given type - - Object = #objref - Logical_type_id = string() - Contexts = [Context] - Context = #'IOP_ServiceContext'{context_id = CtxId, context_data = CtxData} - CtxId = ?ORBER_GENERIC_CTX_ID - CtxData = {interface, Interface} | {userspecific, term()} | {configuration, Options} - Interface = string() - Options = [{Key, Value}] - Key = ssl_client_options - Value = allowed value associated with the given key - Return = boolean() | {'EXCEPTION', E} - - -

The Logical_type_id is a string that is a share type - identifier (repository id). The function returns true if the object - is an instance of that type or an ancestor of the "most derived" - type of that object.

-

The configuration context is used to override the global - SSL client side - configuration.

-

Note: Other ORB suppliers may not support this function completely - according to the OMG specification. Thus, a is_a call may - raise an exception or respond unpredictable if the Object is - located on a remote node.

- - - - is_remote(Object) -> boolean() - Determine whether or not an object reference is remote - - Object = #objref - - -

This function returns true if an object reference is remote - otherwise false.

- - - - non_existent(Object) -> Return - non_existent(Object, Contexts) -> Return - Return false if the target object do not exist, otherwise true - - Object = #objref - Contexts = [Context] - Context = #'IOP_ServiceContext'{context_id = CtxId, context_data = CtxData} - CtxId = ?ORBER_GENERIC_CTX_ID - CtxData = {interface, Interface} | {userspecific, term()} | {configuration, Options} - Interface = string() - Options = [{Key, Value}] - Key = ssl_client_options - Value = allowed value associated with the given key - Return = boolean() | {'EXCEPTION', E} - - -

This function can be used to test if the object has been destroyed. - It does this without invoking any application level code. The ORB - returns true if it knows that the object is destroyed otherwise - false.

-

The configuration context is used to override the global - SSL client side - configuration.

-

Note: The OMG have specified two different operators, _not_existent (CORBA version 2.0 and 2.2) and - _non_existent (CORBA version 2.3), to be used for this function. It is not mandatory to support - both versions. Thus, a non_existent call may raise an exception or respond unpredictable - if the Object is located on a remote node. Depending on which version, ORB:s you intend to - communicate with supports, you can either use this function or not_existent/1.

- - - - not_existent(Object) -> Return - not_existent(Object, Contexts) -> Return - Return false if the target object do not exist, otherwise true - - Object = #objref - Contexts = [Context] - Context = #'IOP_ServiceContext'{context_id = CtxId, context_data = CtxData} - CtxId = ?ORBER_GENERIC_CTX_ID - CtxData = {interface, Interface} | {userspecific, term()} | {configuration, Options} - Interface = string() - Options = [{Key, Value}] - Key = ssl_client_options - Value = allowed value associated with the given key - Return = boolean() | {'EXCEPTION', E} - - -

This function is implemented due to Interoperable purposes. Behaves as - non_existent except the operator _not_existent is used when - communicating with other ORB:s.

-

The configuration context is used to override the global - SSL client side - configuration.

- - - - is_equivalent(Object, OtherObject) -> boolean() - Return true if the target object and the supplied object easily can be determined to be equal, otherwise false - - Object = #objref - OtherObject = #objref - - -

This function is used to determine if two object references are - equivalent so far the ORB easily can determine. It returns - true if the target object reference is equal to the - other object reference and false otherwise.

- - - - hash(Object, Maximum) -> int() - Return a hash value based on the target object - - Object = #objref - Maximum = int() - - -

This function returns a hash value based on the object reference - that not will change during the lifetime of the object. - The Maximum parameter denotes the upper bound of the value.

- - - - - - -- cgit v1.2.3