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_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...
 
const kIpConfigkNet_IpConfig (kNet net)
 Gets the current node IP configuration. More...
 
kMacAddress kNet_MacAddress (kNet net)
 Gets the current node MAC address. More...
 
const kIpConfigkNet_NextIpConfig (kNet net)
 Reports the IP configuration that will take effect after reset. More...
 
kNetworkSpeed kNet_NextSpeed (kNet net)
 Reports the network speed configuration that will take effect after reset. More...
 
kStatus kNet_NextSpeedInfo (kNet net, kInfoBits *info)
 Reports constraint and validity information for the NextSpeed setting. 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_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_SetNextIpConfig (kNet net, const kIpConfig *config)
 Sets the IP configuration that will take effect after reset. More...
 
kStatus kNet_SetNextSpeed (kNet net, const kNetworkSpeed speed)
 Sets the network speed configuration that will take effect after reset. More...
 
kStatus kNet_SetSyncSource (kNet net, kSyncSource source)
 Sets the source of sychronization signals for the node. More...
 
kNetworkSpeed kNet_Speed (kNet net)
 Gets the current network speed configuration. 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: