module ti.sdo.ipc.transports.TransportNetworkDummy

Dummy implementation to avoid RTSC bug

C synopsis
Individual elements
Configuration settings
Individual elements

C synopsis target-domain sourced in ti/sdo/ipc/transports/TransportNetworkDummy.xdc

#include <ti/sdo/ipc/transports/TransportNetworkDummy.h>

Functions
Void	TransportNetworkDummy_construct// Initialize a new instance object inside the provided structure(TransportNetworkDummy_Struct structP, const TransportNetworkDummy_Params params);
TransportNetworkDummy_Handle	TransportNetworkDummy_create// Allocate and initialize a new instance object and return its handle(const TransportNetworkDummy_Params params, Error_Block eb);
Void	TransportNetworkDummy_delete// Finalize and free this previously allocated instance object, setting the referenced handle to NULL(TransportNetworkDummy_Handle *handleP);
Void	TransportNetworkDummy_destruct// Finalize the instance object inside the provided structure(TransportNetworkDummy_Struct *structP);
Void	TransportNetworkDummy_Params_init// Initialize this config-params structure with supplier-specified defaults before instance creation(TransportNetworkDummy_Params *params);
Functions common to all INetworkTransport modules
Int	TransportNetworkDummy_bind// Bind a resource for the given queueId(TransportNetworkDummy_Handle handle, UInt32 queueId);
Bool	TransportNetworkDummy_put// Send the message over the given transport instance(TransportNetworkDummy_Handle handle, Ptr msg);
Int	TransportNetworkDummy_unbind// Unbind a resource for the given queueId(TransportNetworkDummy_Handle handle, UInt32 queueId);
Functions common to all target instances
	TransportNetworkDummy_handle// Convert this instance structure pointer into an instance handle, TransportNetworkDummy_Handle_downCast// conditionally move one level down the inheritance hierarchy; NULL upon failure, TransportNetworkDummy_Handle_downCast2// conditionally move 2 levels down the inheritance hierarchy; NULL upon failure, TransportNetworkDummy_Handle_label// The label associated with this instance object, TransportNetworkDummy_Handle_name// The name of this instance object, TransportNetworkDummy_Handle_upCast// unconditionally move one level up the inheritance hierarchy, TransportNetworkDummy_Handle_upCast2// unconditionally move 2 levels up the inheritance hierarchy, TransportNetworkDummy_Object_count// The number of statically-created instance objects, TransportNetworkDummy_Object_first// The handle of the first dynamically-created instance object, or NULL, TransportNetworkDummy_Object_get// The handle of the i-th statically-created instance object (array == NULL), TransportNetworkDummy_Object_heap// The heap used to allocate dynamically-created instance objects, TransportNetworkDummy_Object_next// The handle of the next dynamically-created instance object, or NULL, TransportNetworkDummy_struct// Convert this instance handle into an instance structure pointer
Functions common to all target modules
	TransportNetworkDummy_Module_getMask// Returns the diagnostics mask for this module, TransportNetworkDummy_Module_hasMask// Test whether this module has a diagnostics mask, TransportNetworkDummy_Module_heap// The heap from which this module allocates memory, TransportNetworkDummy_Module_id// Get this module's unique id, TransportNetworkDummy_Module_setMask// Set the diagnostics mask for this module, TransportNetworkDummy_Module_startupDone// Test if this module has completed startup
Typedefs
typedef TransportNetworkDummy_Object *	TransportNetworkDummy_Handle// Client reference to an instance object;
typedef struct	TransportNetworkDummy_Object// Opaque internal representation of an instance object TransportNetworkDummy_Object;
typedef struct	TransportNetworkDummy_Params// Instance config-params structure ...
typedef struct	TransportNetworkDummy_Struct// Opaque client structure large enough to hold an instance object TransportNetworkDummy_Struct;

Module-Wide Built-Ins

index URL

C synopsis target-domain

Types_ModuleId TransportNetworkDummy_Module_id();

// Get this module's unique id

Bool TransportNetworkDummy_Module_startupDone();

// Test if this module has completed startup

IHeap_Handle TransportNetworkDummy_Module_heap();

// The heap from which this module allocates memory

Bool TransportNetworkDummy_Module_hasMask();

// Test whether this module has a diagnostics mask

Bits16 TransportNetworkDummy_Module_getMask();

// Returns the diagnostics mask for this module

Void TransportNetworkDummy_Module_setMask(Bits16 mask);

// Set the diagnostics mask for this module

Instance Object Types

index URL

C synopsis target-domain

typedef struct TransportNetworkDummy_Object TransportNetworkDummy_Object;

// Opaque internal representation of an instance object

typedef TransportNetworkDummy_Object *TransportNetworkDummy_Handle;

// Client reference to an instance object

typedef struct TransportNetworkDummy_Struct TransportNetworkDummy_Struct;

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

TransportNetworkDummy_Handle TransportNetworkDummy_handle(TransportNetworkDummy_Struct *structP);

// Convert this instance structure pointer into an instance handle

TransportNetworkDummy_Struct *TransportNetworkDummy_struct(TransportNetworkDummy_Handle handle);

// Convert this instance handle into an instance structure pointer

Instance Config Parameters

index URL

C synopsis target-domain

typedef struct TransportNetworkDummy_Params {

// Instance config-params structure

IInstance_Params *instance;

// Common per-instance configs

} TransportNetworkDummy_Params;

Void TransportNetworkDummy_Params_init(TransportNetworkDummy_Params *params);

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

Runtime Instance Creation

index URL

C synopsis target-domain

TransportNetworkDummy_Handle TransportNetworkDummy_create(const TransportNetworkDummy_Params *params, Error_Block *eb);

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

Void TransportNetworkDummy_construct(TransportNetworkDummy_Struct *structP, const TransportNetworkDummy_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 TransportNetworkDummy_delete(TransportNetworkDummy_Handle *handleP);

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

Void TransportNetworkDummy_destruct(TransportNetworkDummy_Struct *structP);

// Finalize the instance object inside the provided structure

TransportNetworkDummy_bind() // instance

index URL

Bind a resource for the given queueId

C synopsis target-domain

Int TransportNetworkDummy_bind(TransportNetworkDummy_Handle handle, UInt32 queueId);

ARGUMENTS

handle — handle of a previously-created TransportNetworkDummy instance object

TransportNetworkDummy_put() // instance

index URL

Send the message over the given transport instance

C synopsis target-domain

Bool TransportNetworkDummy_put(TransportNetworkDummy_Handle handle, Ptr msg);

ARGUMENTS

handle — handle of a previously-created TransportNetworkDummy instance object

TransportNetworkDummy_unbind() // instance

index URL

Unbind a resource for the given queueId

C synopsis target-domain

Int TransportNetworkDummy_unbind(TransportNetworkDummy_Handle handle, UInt32 queueId);

ARGUMENTS

handle — handle of a previously-created TransportNetworkDummy instance object

Instance Convertors

index URL

C synopsis target-domain

INetworkTransport_Handle TransportNetworkDummy_Handle_upCast(TransportNetworkDummy_Handle handle);

// unconditionally move one level up the inheritance hierarchy

TransportNetworkDummy_Handle TransportNetworkDummy_Handle_downCast(INetworkTransport_Handle handle);

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

ITransport_Handle TransportNetworkDummy_Handle_upCast2(TransportNetworkDummy_Handle handle);

// unconditionally move 2 levels up the inheritance hierarchy

TransportNetworkDummy_Handle TransportNetworkDummy_Handle_downCast2(ITransport_Handle handle);

// conditionally move 2 levels down the inheritance hierarchy; NULL upon failure

Instance Built-Ins

index URL

C synopsis target-domain

Int TransportNetworkDummy_Object_count();

// The number of statically-created instance objects

TransportNetworkDummy_Handle TransportNetworkDummy_Object_get(TransportNetworkDummy_Object *array, Int i);

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

TransportNetworkDummy_Handle TransportNetworkDummy_Object_first();

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

TransportNetworkDummy_Handle TransportNetworkDummy_Object_next(TransportNetworkDummy_Handle handle);

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

IHeap_Handle TransportNetworkDummy_Object_heap();

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

Types_Label *TransportNetworkDummy_Handle_label(TransportNetworkDummy_Handle handle, Types_Label *buf);

// The label associated with this instance object

String TransportNetworkDummy_Handle_name(TransportNetworkDummy_Handle handle);

// The name of this instance object

Configuration settings sourced in ti/sdo/ipc/transports/TransportNetworkDummy.xdc

var TransportNetworkDummy = xdc.useModule('ti.sdo.ipc.transports.TransportNetworkDummy');

module-wide config parameters

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

per-instance config parameters

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

per-instance creation

var inst = TransportNetworkDummy.create// Create an instance-object(params);

metaonly config TransportNetworkDummy.common$ // module-wide

index URL

Common module configuration parameters

Configuration settings

TransportNetworkDummy.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 TransportNetworkDummy.Params;

// Instance config-params object

Static Instance Creation

index URL

Configuration settings

var params = new TransportNetworkDummy.Params;

// Allocate instance config-params

params.config = ...

// Assign individual configs

var inst = TransportNetworkDummy.create(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:35:46 GMT