interface ti.sdo.utils.INameServerRemote
index URL

Interface for remote NameServer accesses

XDCspec summary sourced in ti/sdo/utils/INameServerRemote.xdc
interface INameServerRemote {  ...
// inherits xdc.runtime.IModule
instance:  ...
XDCspec declarations sourced in ti/sdo/utils/INameServerRemote.xdc
package ti.sdo.utils;
 
interface INameServerRemote {
module-wide constants & types
    enum Status// Status codes returned by certain calls {
        S_SUCCESS,
        E_FAIL,
        E_ERROR
    };
module-wide config parameters
    metaonly config Types.Common$ common$// Common module configuration parameters;
module-wide functions
    Int attach// Function is called by Ipc_attach() through NameServer_SetupProxy(UInt16 remoteProcId, Ptr sharedAddr);
    Int detach// Function is called by Ipc_detach() through NameServer_SetupProxy(UInt16 remoteProcId);
    SizeT sharedMemReq// Returns the shared memory size requirement for a single instance(Ptr sharedAddr);
 
 
instance:
per-instance creation
    create// Create an instance-object(UInt16 procId);
per-instance functions
    Int get// (String instanceName, String name, Ptr value, UInt32 *valueLen, ISync.Handle syncHandle, Error.Block *eb);
}
 
enum INameServerRemote.Status
index URL

Status codes returned by certain calls

XDCspec declarations sourced in ti/sdo/utils/INameServerRemote.xdc
enum Status {
    S_SUCCESS,
    E_FAIL,
    E_ERROR
};
 
 
metaonly config INameServerRemote.common$  // module-wide
index URL

Common module configuration parameters

XDCspec declarations sourced in ti/sdo/utils/INameServerRemote.xdc
metaonly config Types.Common$ common$;
 
DETAILS
All modules have this configuration parameter. Its name contains the '$' character to ensure it does not conflict with configuration parameters declared by the module. This allows new configuration parameters to be added in the future without any chance of breaking existing modules.
 
INameServerRemote.attach()  // module-wide
index URL

Function is called by Ipc_attach() through NameServer_SetupProxy

XDCspec declarations sourced in ti/sdo/utils/INameServerRemote.xdc
Int attach(UInt16 remoteProcId, Ptr sharedAddr);
 
 
INameServerRemote.detach()  // module-wide
index URL

Function is called by Ipc_detach() through NameServer_SetupProxy

XDCspec declarations sourced in ti/sdo/utils/INameServerRemote.xdc
Int detach(UInt16 remoteProcId);
 
 
INameServerRemote.sharedMemReq()  // module-wide
index URL

Returns the shared memory size requirement for a single instance

XDCspec declarations sourced in ti/sdo/utils/INameServerRemote.xdc
SizeT sharedMemReq(Ptr sharedAddr);
 
ARGUMENTS
sharedAddr — Shared address
RETURNS
Number of MAUs needed to create the instance.
DETAILS
Function is called during Ipc_attach() through NameServer_SetupProxy.
Static Instance Creation
index URL

XDCspec declarations sourced in ti/sdo/utils/INameServerRemote.xdc
create(UInt16 procId);
// Create an instance-object
 
INameServerRemote.get()  // instance
index URL
XDCspec declarations sourced in ti/sdo/utils/INameServerRemote.xdc
Int get(String instanceName, String name, Ptr value, UInt32 *valueLen, ISync.Handle syncHandle, Error.Block *eb);
 
generated on Fri, 21 Aug 2015 19:36:04 GMT