FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kNet Class Reference

Description

Represents configuration for various node network services (e.g. control, data).

Inheritance diagram for kNet:
Inheritance graph

Public Member Functions

kStatus kNet_AddDataInPort (kNet net, k32u sourceNode, k32u sourcePort)
 Defines a network data input port for this node. More...
 
kStatus kNet_Clear (kNet net)
 Resets net mode settings to defaults. More...
 
kStatus kNet_ClearAll (kNet net, kBool clearIpConfig)
 Resets net mode and device settings to defaults. More...
 
const kDataInSourcekNet_DataInPortAt (kNet net, kSize index)
 Accesses information describing the network data input port at the specified index. More...
 
kSize kNet_DataInPortCount (kNet net)
 Reports the number of network data input ports defined for this node. More...
 
kSize kNet_DataInSocketBufferSize (kNet net)
 Reports the socket buffer size associated with each data input port. More...
 
kSize kNet_DataInSocketBufferSizeInfo (kNet net, kInfoSize *info)
 Reports constraint and validity information for the DataInSocketBufferSize setting. More...
 
kStatus kNet_DataInThreadAffinity (kNet net, kBitArray affinity)
 Gets the thread affinity for any network data input threads. More...
 
kStatus kNet_DataInThreadAffinityInfo (kNet net, kInfo *info)
 Reports constraint and validity information for the kNet_DataInThreadAffinity setting. More...
 
kThreadPriorityClass kNet_DataInThreadPriorityClass (kNet net)
 Gets the thread priority class for any network data input threads. More...
 
kStatus kNet_DataInThreadPriorityClassInfo (kNet net, kInfo32s *info)
 Reports constraint and validity information for the DataInThreadPriorityClass setting. More...
 
k32s kNet_DataInThreadPriorityOffset (kNet net)
 Gets the thread priority offset for any network data input threads. More...
 
kStatus kNet_DataInThreadPriorityOffsetInfo (kNet net, kInfo32s *info)
 Reports constraint and validity information for the DataInThreadPriorityOffset setting. More...
 
kSize kNet_DataOutMaxQueueCount (kNet net)
 Reports the maximum queue item count associated with a single network data output port. More...
 
kSize kNet_DataOutMaxQueueSize (kNet net)
 Reports the maximum total queue size (in bytes) associated with a single network data output port. More...
 
kSize kNet_DataOutPortCount (kNet net)
 Reports the number of network data output ports exposed by this node. More...
 
kSize kNet_DataOutSocketBufferSize (kNet net)
 Reports the socket buffer size associated with each data output port. More...
 
kSize kNet_DataOutSocketBufferSizeInfo (kNet net, kInfoSize *info)
 Reports constraint and validity information for the DataOutSocketBufferSize setting. More...
 
kStatus kNet_DataOutThreadAffinity (kNet net, kBitArray affinity)
 Gets the thread affinity for any network data output threads. More...
 
kStatus kNet_DataOutThreadAffinityInfo (kNet net, kInfo *info)
 Reports constraint and validity information for the kNet_DataOutThreadAffinity setting. More...
 
kThreadPriorityClass kNet_DataOutThreadPriorityClass (kNet net)
 Gets the thread priority class for any network data output threads. More...
 
kStatus kNet_DataOutThreadPriorityClassInfo (kNet net, kInfo32s *info)
 Reports constraint and validity information for the DataOutThreadPriorityClass setting. More...
 
k32s kNet_DataOutThreadPriorityOffset (kNet net)
 Gets the thread priority offset for any network data output threads. More...
 
kStatus kNet_DataOutThreadPriorityOffsetInfo (kNet net, kInfo32s *info)
 Reports constraint and validity information for the DataOutThreadPriorityOffset setting. More...
 
kNetInterface kNet_InterfaceAt (kNet net, kSize index)
 Gets the network interface at the specified index. More...
 
kSize kNet_InterfaceCount (kNet net)
 Gets the number of available network interfaces. More...
 
kStatus kNet_RemoveDataInPort (kNet net, kSize index)
 Removes the network data input port at the specified index. More...
 
kStatus kNet_SetDataInPortAt (kNet net, kSize index, k32u sourceNode, k32u sourcePort)
 Sets information describing the network data input port at the specified index. More...
 
kStatus kNet_SetDataInPortCount (kNet net, kSize count)
 Sets the number of data input ports defined for this node. More...
 
kStatus kNet_SetDataInSocketBufferSize (kNet net, kSize size)
 Sets the socket buffer size associated with each data input port. More...
 
kStatus kNet_SetDataInThreadAffinity (kNet net, kBitArray affinity)
 Sets the thread affinity for any network data input threads. More...
 
kStatus kNet_SetDataInThreadPriorityClass (kNet net, kThreadPriorityClass priorityClass)
 Sets the thread priority class for any network data input threads. More...
 
k32s kNet_SetDataInThreadPriorityOffset (kNet net, k32s priorityOffset)
 Sets the thread priority offset for any network data input threads. More...
 
kStatus kNet_SetDataOutMaxQueueCount (kNet net, kSize count)
 Sets the maximum queue item count associated with a single network data output port. More...
 
kStatus kNet_SetDataOutMaxQueueSize (kNet net, kSize size)
 Sets the maximum total queue size (in bytes) associated with a single network data output port. More...
 
kStatus kNet_SetDataOutPortCount (kNet net, kSize portCount)
 Sets the number of network data output ports exposed by this node. More...
 
kStatus kNet_SetDataOutSocketBufferSize (kNet net, kSize size)
 Sets the socket buffer size associated with each data output port. More...
 
kStatus kNet_SetDataOutThreadAffinity (kNet net, kBitArray affinity)
 Sets the thread affinity for any network data output threads. More...
 
kStatus kNet_SetDataOutThreadPriorityClass (kNet net, kThreadPriorityClass priorityClass)
 Sets the thread priority class for any network data output threads. More...
 
k32s kNet_SetDataOutThreadPriorityOffset (kNet net, k32s priorityOffset)
 Sets the thread priority offset for any network data output threads. More...
 
kStatus kNet_SetSyncSource (kNet net, kSyncSource source)
 Sets the source of synchronization signals for the node. More...
 
kSyncSource kNet_SyncSource (kNet net)
 Gets the synchronization source for the node. More...
 
kStatus kNet_SyncSourceInfo (kNet net, kInfoBits *info)
 Reports constraint and validity information for the SyncSource setting. More...
 

The documentation for this class was generated from the following file: