FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kNet.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_NET_H
9 #define K_FIRESYNC_NET_H
10 
11 #include <kFireSync/kNodeDef.h>
12 
13 kBeginHeader()
14 
15 
21 //typedef kObject kNet; --forward-declared in kFsDef.x.h
22 
23 
30 kFsFx(kStatus) kNet_Clear(kNet net);
31 
46 kFsFx(kStatus) kNet_SetSyncSource(kNet net, kSyncSource source);
47 
55 kFsFx(kSyncSource) kNet_SyncSource(kNet net);
56 
65 kFsFx(kStatus) kNet_SyncSourceInfo(kNet net, kInfoBits* info);
66 
75 kFsFx(kStatus) kNet_ClearAll(kNet net, kBool clearIpConfig);
76 
84 kFsFx(kNetworkSpeed) kNet_Speed(kNet net);
85 
93 kFsFx(kNetworkSpeed) kNet_NextSpeed(kNet net);
94 
106 kFsFx(kStatus) kNet_SetNextSpeed(kNet net, const kNetworkSpeed speed);
107 
116 kFsFx(kStatus) kNet_NextSpeedInfo(kNet net, kInfoBits* info);
117 
125 kFsFx(const kIpConfig*) kNet_IpConfig(kNet net);
126 
134 kFsFx(const kIpConfig*) kNet_NextIpConfig(kNet net);
135 
147 kFsFx(kStatus) kNet_SetNextIpConfig(kNet net, const kIpConfig* config);
148 
156 kFsFx(kMacAddress) kNet_MacAddress(kNet net);
157 
166 kFsFx(kStatus) kNet_SetDataOutPortCount(kNet net, kSize portCount);
167 
175 kFsFx(kSize) kNet_DataOutPortCount(kNet net);
176 
185 kFsFx(kStatus) kNet_SetDataOutMaxQueueSize(kNet net, kSize size);
186 
194 kFsFx(kSize) kNet_DataOutMaxQueueSize(kNet net);
195 
204 kFsFx(kStatus) kNet_SetDataOutMaxQueueCount(kNet net, kSize count);
205 
213 kFsFx(kSize) kNet_DataOutMaxQueueCount(kNet net);
214 
223 kFsFx(kStatus) kNet_SetDataInPortCount(kNet net, kSize count);
224 
234 kFsFx(kStatus) kNet_AddDataInPort(kNet net, k32u sourceNode, k32u sourcePort);
235 
244 kFsFx(kStatus) kNet_RemoveDataInPort(kNet net, kSize index);
245 
253 kFsFx(kSize) kNet_DataInPortCount(kNet net);
254 
265 kFsFx(kStatus) kNet_SetDataInPortAt(kNet net, kSize index, k32u sourceNode, k32u sourcePort);
266 
275 kFsFx(const kDataInSource*) kNet_DataInPortAt(kNet net, kSize index);
276 
277 kEndHeader()
278 
279 #include <kFireSync/Client/kNet.x.h>
280 
281 #endif
kSyncSource
Represents FireSync synchronization sources.
kNet::kNet_DataInPortCount
kSize kNet_DataInPortCount(kNet net)
Reports the number of network data input ports defined for this node.
kInfoBits
Represents constraint and validity information for a bit flag setting.
Definition: kInfo.h:454
kNet::kNet_SetDataOutMaxQueueCount
kStatus kNet_SetDataOutMaxQueueCount(kNet net, kSize count)
Sets the maximum queue item count associated with a single network data output port.
kNet::kNet_DataOutMaxQueueCount
kSize kNet_DataOutMaxQueueCount(kNet net)
Reports the maximum queue item count associated with a single network data output port...
kNet::kNet_RemoveDataInPort
kStatus kNet_RemoveDataInPort(kNet net, kSize index)
Removes the network data input port at the specified index.
kNet::kNet_DataInPortAt
const kDataInSource * kNet_DataInPortAt(kNet net, kSize index)
Accesses information describing the network data input port at the specified index.
kNet::kNet_SetDataInPortCount
kStatus kNet_SetDataInPortCount(kNet net, kSize count)
Sets the number of data input ports defined for this node.
kIpConfig
Represents address configuration for an Internet Protocol adapter.
Definition: kFsDef.h:156
kNet::kNet_IpConfig
const kIpConfig * kNet_IpConfig(kNet net)
Gets the current node IP configuration.
kNodeDef.h
Essential declarations related to FireSync nodes.
kDataInSource
Represents a remote Net Out port that will act as the source for a local Net In port.
Definition: kNodeDef.h:1540
kNet::kNet_Clear
kStatus kNet_Clear(kNet net)
Resets net mode settings to defaults.
kNet::kNet_SetDataOutPortCount
kStatus kNet_SetDataOutPortCount(kNet net, kSize portCount)
Sets the number of network data output ports exposed by this node.
kNet::kNet_ClearAll
kStatus kNet_ClearAll(kNet net, kBool clearIpConfig)
Resets net mode and device settings to defaults.
kNet::kNet_DataOutMaxQueueSize
kSize kNet_DataOutMaxQueueSize(kNet net)
Reports the maximum total queue size (in bytes) associated with a single network data output port...
kNet::kNet_SyncSource
kSyncSource kNet_SyncSource(kNet net)
Gets the synchronization source for the node.
kMacAddress
Represents an Ethernet address.
Definition: kFsDef.h:95
kNet
Represents configuration for various node network services (e.g. control, data).
kNet::kNet_Speed
kNetworkSpeed kNet_Speed(kNet net)
Gets the current network speed configuration.
kNet::kNet_SyncSourceInfo
kStatus kNet_SyncSourceInfo(kNet net, kInfoBits *info)
Reports constraint and validity information for the SyncSource setting.
kNet::kNet_SetNextIpConfig
kStatus kNet_SetNextIpConfig(kNet net, const kIpConfig *config)
Sets the IP configuration that will take effect after reset.
kNet::kNet_SetDataOutMaxQueueSize
kStatus kNet_SetDataOutMaxQueueSize(kNet net, kSize size)
Sets the maximum total queue size (in bytes) associated with a single network data output port...
kNet::kNet_NextSpeedInfo
kStatus kNet_NextSpeedInfo(kNet net, kInfoBits *info)
Reports constraint and validity information for the NextSpeed setting.
kNet::kNet_SetNextSpeed
kStatus kNet_SetNextSpeed(kNet net, const kNetworkSpeed speed)
Sets the network speed configuration that will take effect after reset.
kNet::kNet_NextSpeed
kNetworkSpeed kNet_NextSpeed(kNet net)
Reports the network speed configuration that will take effect after reset.
kNet::kNet_AddDataInPort
kStatus kNet_AddDataInPort(kNet net, k32u sourceNode, k32u sourcePort)
Defines a network data input port for this node.
kNet::kNet_NextIpConfig
const kIpConfig * kNet_NextIpConfig(kNet net)
Reports the IP configuration that will take effect after reset.
kNet::kNet_DataOutPortCount
kSize kNet_DataOutPortCount(kNet net)
Reports the number of network data output ports exposed by this node.
kNet::kNet_MacAddress
kMacAddress kNet_MacAddress(kNet net)
Gets the current node MAC address.
kNet::kNet_SetDataInPortAt
kStatus kNet_SetDataInPortAt(kNet net, kSize index, k32u sourceNode, k32u sourcePort)
Sets information describing the network data input port at the specified index.
kNetworkSpeed
Represents a network speed.
kNet::kNet_SetSyncSource
kStatus kNet_SetSyncSource(kNet net, kSyncSource source)
Sets the source of sychronization signals for the node.