module ti.sdo.utils.NameServerRemoteNull

C synopsis
Individual elements
Configuration settings
Individual elements

C synopsis target-domain sourced in ti/sdo/utils/NameServerRemoteNull.xdc

#include <ti/sdo/utils/NameServerRemoteNull.h>

Functions
Void	NameServerRemoteNull_construct// Initialize a new instance object inside the provided structure(NameServerRemoteNull_Struct structP, UInt16 procId, const NameServerRemoteNull_Params params);
NameServerRemoteNull_Handle	NameServerRemoteNull_create// Allocate and initialize a new instance object and return its handle(UInt16 procId, const NameServerRemoteNull_Params params, Error_Block eb);
Void	NameServerRemoteNull_delete// Finalize and free this previously allocated instance object, setting the referenced handle to NULL(NameServerRemoteNull_Handle *handleP);
Void	NameServerRemoteNull_destruct// Finalize the instance object inside the provided structure(NameServerRemoteNull_Struct *structP);
Void	NameServerRemoteNull_Params_init// Initialize this config-params structure with supplier-specified defaults before instance creation(NameServerRemoteNull_Params *params);
Functions common to all INameServerRemote modules
Int	NameServerRemoteNull_attach// Function is called by Ipc_attach() through NameServer_SetupProxy(UInt16 remoteProcId, Ptr sharedAddr);
Int	NameServerRemoteNull_detach// Function is called by Ipc_detach() through NameServer_SetupProxy(UInt16 remoteProcId);
Int	NameServerRemoteNull_get// (NameServerRemoteNull_Handle handle, String instanceName, String name, Ptr value, UInt32 valueLen, ISync_Handle syncHandle, Error_Block eb);
SizeT	NameServerRemoteNull_sharedMemReq// Returns the shared memory size requirement for a single instance(Ptr sharedAddr);
Functions common to all target instances
	NameServerRemoteNull_handle// Convert this instance structure pointer into an instance handle, NameServerRemoteNull_Handle_downCast// conditionally move one level down the inheritance hierarchy; NULL upon failure, NameServerRemoteNull_Handle_label// The label associated with this instance object, NameServerRemoteNull_Handle_name// The name of this instance object, NameServerRemoteNull_Handle_upCast// unconditionally move one level up the inheritance hierarchy, NameServerRemoteNull_Object_count// The number of statically-created instance objects, NameServerRemoteNull_Object_first// The handle of the first dynamically-created instance object, or NULL, NameServerRemoteNull_Object_get// The handle of the i-th statically-created instance object (array == NULL), NameServerRemoteNull_Object_heap// The heap used to allocate dynamically-created instance objects, NameServerRemoteNull_Object_next// The handle of the next dynamically-created instance object, or NULL, NameServerRemoteNull_struct// Convert this instance handle into an instance structure pointer
Functions common to all target modules
	NameServerRemoteNull_Module_getMask// Returns the diagnostics mask for this module, NameServerRemoteNull_Module_hasMask// Test whether this module has a diagnostics mask, NameServerRemoteNull_Module_heap// The heap from which this module allocates memory, NameServerRemoteNull_Module_id// Get this module's unique id, NameServerRemoteNull_Module_setMask// Set the diagnostics mask for this module, NameServerRemoteNull_Module_startupDone// Test if this module has completed startup
Typedefs
typedef NameServerRemoteNull_Object *	NameServerRemoteNull_Handle// Client reference to an instance object;
typedef struct	NameServerRemoteNull_Object// Opaque internal representation of an instance object NameServerRemoteNull_Object;
typedef struct	NameServerRemoteNull_Params// Instance config-params structure ...
typedef enum	NameServerRemoteNull_Status// Status codes returned by certain calls ...
typedef struct	NameServerRemoteNull_Struct// Opaque client structure large enough to hold an instance object NameServerRemoteNull_Struct;

enum NameServerRemoteNull_Status

index URL

Status codes returned by certain calls

C synopsis target-domain

typedef enum NameServerRemoteNull_Status {

NameServerRemoteNull_S_SUCCESS,

NameServerRemoteNull_E_FAIL,

NameServerRemoteNull_E_ERROR

} NameServerRemoteNull_Status;

NameServerRemoteNull_attach() // module-wide

index URL

Function is called by Ipc_attach() through NameServer_SetupProxy

C synopsis target-domain

Int NameServerRemoteNull_attach(UInt16 remoteProcId, Ptr sharedAddr);

NameServerRemoteNull_detach() // module-wide

index URL

Function is called by Ipc_detach() through NameServer_SetupProxy

C synopsis target-domain

Int NameServerRemoteNull_detach(UInt16 remoteProcId);

NameServerRemoteNull_sharedMemReq() // module-wide

index URL

Returns the shared memory size requirement for a single instance

C synopsis target-domain

SizeT NameServerRemoteNull_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.

Module-Wide Built-Ins

index URL

C synopsis target-domain

Types_ModuleId NameServerRemoteNull_Module_id();

// Get this module's unique id

Bool NameServerRemoteNull_Module_startupDone();

// Test if this module has completed startup

IHeap_Handle NameServerRemoteNull_Module_heap();

// The heap from which this module allocates memory

Bool NameServerRemoteNull_Module_hasMask();

// Test whether this module has a diagnostics mask

Bits16 NameServerRemoteNull_Module_getMask();

// Returns the diagnostics mask for this module

Void NameServerRemoteNull_Module_setMask(Bits16 mask);

// Set the diagnostics mask for this module

Instance Object Types

index URL

C synopsis target-domain

typedef struct NameServerRemoteNull_Object NameServerRemoteNull_Object;

// Opaque internal representation of an instance object

typedef NameServerRemoteNull_Object *NameServerRemoteNull_Handle;

// Client reference to an instance object

typedef struct NameServerRemoteNull_Struct NameServerRemoteNull_Struct;

// Opaque client structure large enough to hold an instance object

NameServerRemoteNull_Handle NameServerRemoteNull_handle(NameServerRemoteNull_Struct *structP);

// Convert this instance structure pointer into an instance handle

NameServerRemoteNull_Struct *NameServerRemoteNull_struct(NameServerRemoteNull_Handle handle);

// Convert this instance handle into an instance structure pointer

Instance Config Parameters

index URL

C synopsis target-domain

typedef struct NameServerRemoteNull_Params {

// Instance config-params structure

IInstance_Params *instance;

// Common per-instance configs

} NameServerRemoteNull_Params;

Void NameServerRemoteNull_Params_init(NameServerRemoteNull_Params *params);

// Initialize this config-params structure with supplier-specified defaults before instance creation

Runtime Instance Creation

index URL

C synopsis target-domain

NameServerRemoteNull_Handle NameServerRemoteNull_create(UInt16 procId, const NameServerRemoteNull_Params *params, Error_Block *eb);

// Allocate and initialize a new instance object and return its handle

Void NameServerRemoteNull_construct(NameServerRemoteNull_Struct *structP, UInt16 procId, const NameServerRemoteNull_Params *params);

// Initialize a new instance object inside the provided structure

ARGUMENTS

params — per-instance config params, or NULL to select default values (target-domain only)

eb — active error-handling block, or NULL to select default policy (target-domain only)

Instance Deletion

index URL

C synopsis target-domain

Void NameServerRemoteNull_delete(NameServerRemoteNull_Handle *handleP);

// Finalize and free this previously allocated instance object, setting the referenced handle to NULL

Void NameServerRemoteNull_destruct(NameServerRemoteNull_Struct *structP);

// Finalize the instance object inside the provided structure

NameServerRemoteNull_get() // instance

index URL

C synopsis target-domain

Int NameServerRemoteNull_get(NameServerRemoteNull_Handle handle, String instanceName, String name, Ptr value, UInt32 *valueLen, ISync_Handle syncHandle, Error_Block *eb);

ARGUMENTS

handle — handle of a previously-created NameServerRemoteNull instance object

Instance Convertors

index URL

C synopsis target-domain

INameServerRemote_Handle NameServerRemoteNull_Handle_upCast(NameServerRemoteNull_Handle handle);

// unconditionally move one level up the inheritance hierarchy

NameServerRemoteNull_Handle NameServerRemoteNull_Handle_downCast(INameServerRemote_Handle handle);

// conditionally move one level down the inheritance hierarchy; NULL upon failure

Instance Built-Ins

index URL

C synopsis target-domain

Int NameServerRemoteNull_Object_count();

// The number of statically-created instance objects

NameServerRemoteNull_Handle NameServerRemoteNull_Object_get(NameServerRemoteNull_Object *array, Int i);

// The handle of the i-th statically-created instance object (array == NULL)

NameServerRemoteNull_Handle NameServerRemoteNull_Object_first();

// The handle of the first dynamically-created instance object, or NULL

NameServerRemoteNull_Handle NameServerRemoteNull_Object_next(NameServerRemoteNull_Handle handle);

// The handle of the next dynamically-created instance object, or NULL

IHeap_Handle NameServerRemoteNull_Object_heap();

// The heap used to allocate dynamically-created instance objects

Types_Label *NameServerRemoteNull_Handle_label(NameServerRemoteNull_Handle handle, Types_Label *buf);

// The label associated with this instance object

String NameServerRemoteNull_Handle_name(NameServerRemoteNull_Handle handle);

// The name of this instance object

Configuration settings sourced in ti/sdo/utils/NameServerRemoteNull.xdc

var NameServerRemoteNull = xdc.useModule('ti.sdo.utils.NameServerRemoteNull');

module-wide constants & types

values of type NameServerRemoteNull.Status// Status codes returned by certain calls

const NameServerRemoteNull.S_SUCCESS;

const NameServerRemoteNull.E_FAIL;

const NameServerRemoteNull.E_ERROR;

module-wide config parameters

NameServerRemoteNull.common$// Common module configuration parameters = Types.Common$ undefined;

per-instance config parameters

var params = new NameServerRemoteNull.Params// Instance config-params object;

per-instance creation

var inst = NameServerRemoteNull.create// Create an instance-object(UInt16 procId, params);

enum NameServerRemoteNull.Status

index URL

Status codes returned by certain calls

Configuration settings

values of type NameServerRemoteNull.Status

const NameServerRemoteNull.S_SUCCESS;

const NameServerRemoteNull.E_FAIL;

const NameServerRemoteNull.E_ERROR;

C SYNOPSIS

NameServerRemoteNull_Status

metaonly config NameServerRemoteNull.common$ // module-wide

index URL

Common module configuration parameters

Configuration settings

NameServerRemoteNull.common$ = Types.Common$ undefined;

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.

Instance Config Parameters

index URL

Configuration settings

var params = new NameServerRemoteNull.Params;

// Instance config-params object

Static Instance Creation

index URL

Configuration settings

var params = new NameServerRemoteNull.Params;

// Allocate instance config-params

params.config = ...

// Assign individual configs

var inst = NameServerRemoteNull.create(UInt16 procId, params);

// Create an instance-object

ARGUMENTS

params — per-instance config params, or NULL to select default values (target-domain only)

eb — active error-handling block, or NULL to select default policy (target-domain only)

generated on Fri, 21 Aug 2015 19:36:05 GMT