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 
19 //typedef kObject kNet; --forward-declared in kFsDef.x.h
20 
28 kFsFx(kStatus) kNet_Clear(kNet net);
29 
37 kFsFx(kSize) kNet_InterfaceCount(kNet net);
38 
47 kFsFx(kNetInterface) kNet_InterfaceAt(kNet net, kSize index);
48 
63 kFsFx(kStatus) kNet_SetSyncSource(kNet net, kSyncSource source);
64 
72 kFsFx(kSyncSource) kNet_SyncSource(kNet net);
73 
82 kFsFx(kStatus) kNet_SyncSourceInfo(kNet net, kInfoBits* info);
83 
92 kFsFx(kStatus) kNet_ClearAll(kNet net, kBool clearIpConfig);
93 
102 kFsFx(kStatus) kNet_SetDataOutPortCount(kNet net, kSize portCount);
103 
111 kFsFx(kSize) kNet_DataOutPortCount(kNet net);
112 
122 
131 
141 
150 
167 
176 
186 
196 kFsFx(k32s) kNet_SetDataOutThreadPriorityOffset(kNet net, k32s priorityOffset);
197 
206 
216 
233 
242 kFsFx(kStatus) kNet_DataOutThreadAffinity(kNet net, kBitArray affinity);
243 
253 
263 
272 
282 
292 
301 
311 
320 kFsFx(kStatus) kNet_SetDataInPortCount(kNet net, kSize count);
321 
331 kFsFx(kStatus) kNet_AddDataInPort(kNet net, k32u sourceNode, k32u sourcePort);
332 
341 kFsFx(kStatus) kNet_RemoveDataInPort(kNet net, kSize index);
342 
350 kFsFx(kSize) kNet_DataInPortCount(kNet net);
351 
362 kFsFx(kStatus) kNet_SetDataInPortAt(kNet net, kSize index, k32u sourceNode, k32u sourcePort);
363 
372 kFsFx(const kDataInSource*) kNet_DataInPortAt(kNet net, kSize index);
373 
390 
399 
409 
419 kFsFx(k32s) kNet_SetDataInThreadPriorityOffset(kNet net, k32s priorityOffset);
420 
429 
439 
455 kFsFx(kStatus) kNet_SetDataInThreadAffinity(kNet net, kBitArray affinity);
456 
465 kFsFx(kStatus) kNet_DataInThreadAffinity(kNet net, kBitArray affinity);
466 
476 
477 #include <kFireSync/Client/kNet.x.h>
478 
479 #endif
kStatus kNet_DataInThreadAffinityInfo(kNet net, kInfo *info)
Reports constraint and validity information for the kNet_DataInThreadAffinity setting.
kStatus kNet_DataInThreadPriorityOffsetInfo(kNet net, kInfo32s *info)
Reports constraint and validity information for the DataInThreadPriorityOffset setting.
Represents FireSync synchronization sources.
kStatus kNet_DataOutThreadAffinity(kNet net, kBitArray affinity)
Gets the thread affinity for any network data output threads.
k32s kNet_DataOutThreadPriorityOffset(kNet net)
Gets the thread priority offset for any network data output threads.
kStatus kNet_SetDataInThreadPriorityClass(kNet net, kThreadPriorityClass priorityClass)
Sets the thread priority class for any network data input threads.
kSize kNet_DataInPortCount(kNet net)
Reports the number of network data input ports defined for this node.
Represents constraint and validity information for a bit flag setting.
Definition: kInfo.h:544
kStatus kNet_DataOutThreadPriorityClassInfo(kNet net, kInfo32s *info)
Reports constraint and validity information for the DataOutThreadPriorityClass setting.
kStatus kNet_SetDataInSocketBufferSize(kNet net, kSize size)
Sets the socket buffer size associated with each data input port.
kStatus kNet_DataInThreadPriorityClassInfo(kNet net, kInfo32s *info)
Reports constraint and validity information for the DataInThreadPriorityClass setting.
kStatus kNet_SetDataOutMaxQueueCount(kNet net, kSize count)
Sets the maximum queue item count associated with a single network data output port.
kSize kNet_DataOutMaxQueueCount(kNet net)
Reports the maximum queue item count associated with a single network data output port...
kStatus kNet_RemoveDataInPort(kNet net, kSize index)
Removes the network data input port at the specified index.
const kDataInSource * kNet_DataInPortAt(kNet net, kSize index)
Accesses information describing the network data input port at the specified index.
kStatus kNet_SetDataInPortCount(kNet net, kSize count)
Sets the number of data input ports defined for this node.
kStatus kNet_DataOutThreadPriorityOffsetInfo(kNet net, kInfo32s *info)
Reports constraint and validity information for the DataOutThreadPriorityOffset setting.
Represents constraint and validity information for a 32-bit signed integer setting.
Definition: kInfo.h:166
Essential declarations related to FireSync nodes.
kThreadPriorityClass kNet_DataInThreadPriorityClass(kNet net)
Gets the thread priority class for any network data input threads.
Represents a remote Net Out port that will act as the source for a local Net In port.
Definition: kNodeDef.h:1820
kStatus kNet_Clear(kNet net)
Resets net mode settings to defaults.
kStatus kNet_SetDataOutPortCount(kNet net, kSize portCount)
Sets the number of network data output ports exposed by this node.
kStatus kNet_ClearAll(kNet net, kBool clearIpConfig)
Resets net mode and device settings to defaults.
kStatus kNet_SetDataOutThreadAffinity(kNet net, kBitArray affinity)
Sets the thread affinity for any network data output threads.
kSize kNet_DataOutSocketBufferSizeInfo(kNet net, kInfoSize *info)
Reports constraint and validity information for the DataOutSocketBufferSize setting.
kSize kNet_DataOutMaxQueueSize(kNet net)
Reports the maximum total queue size (in bytes) associated with a single network data output port...
kNetInterface kNet_InterfaceAt(kNet net, kSize index)
Gets the network interface at the specified index.
kStatus kNet_SetDataOutThreadPriorityClass(kNet net, kThreadPriorityClass priorityClass)
Sets the thread priority class for any network data output threads.
kSyncSource kNet_SyncSource(kNet net)
Gets the synchronization source for the node.
kStatus kNet_DataOutThreadAffinityInfo(kNet net, kInfo *info)
Reports constraint and validity information for the kNet_DataOutThreadAffinity setting.
k32s kNet_SetDataInThreadPriorityOffset(kNet net, k32s priorityOffset)
Sets the thread priority offset for any network data input threads.
k32s kNet_SetDataOutThreadPriorityOffset(kNet net, k32s priorityOffset)
Sets the thread priority offset for any network data output threads.
kSize kNet_InterfaceCount(kNet net)
Gets the number of available network interfaces.
Represents configuration for network interfaces.
Represents configuration for various node network services (e.g. control, data).
kStatus kNet_SyncSourceInfo(kNet net, kInfoBits *info)
Reports constraint and validity information for the SyncSource setting.
kStatus kNet_SetDataOutMaxQueueSize(kNet net, kSize size)
Sets the maximum total queue size (in bytes) associated with a single network data output port...
kStatus kNet_SetDataInThreadAffinity(kNet net, kBitArray affinity)
Sets the thread affinity for any network data input threads.
Represents constraint and validity information for a kSize setting.
Definition: kInfo.h:370
kStatus kNet_AddDataInPort(kNet net, k32u sourceNode, k32u sourcePort)
Defines a network data input port for this node.
kSize kNet_DataOutPortCount(kNet net)
Reports the number of network data output ports exposed by this node.
kStatus kNet_SetDataOutSocketBufferSize(kNet net, kSize size)
Sets the socket buffer size associated with each data output port.
kSize kNet_DataInSocketBufferSizeInfo(kNet net, kInfoSize *info)
Reports constraint and validity information for the DataInSocketBufferSize setting.
kThreadPriorityClass kNet_DataOutThreadPriorityClass(kNet net)
Gets the thread priority class for any network data output threads.
kStatus kNet_DataInThreadAffinity(kNet net, kBitArray affinity)
Gets the thread affinity for any network data input threads.
kStatus kNet_SetDataInPortAt(kNet net, kSize index, k32u sourceNode, k32u sourcePort)
Sets information describing the network data input port at the specified index.
Represents constraint and validity information for a general setting.
Definition: kInfo.h:64
kSize kNet_DataInSocketBufferSize(kNet net)
Reports the socket buffer size associated with each data input port.
k32s kNet_DataInThreadPriorityOffset(kNet net)
Gets the thread priority offset for any network data input threads.
kStatus kNet_SetSyncSource(kNet net, kSyncSource source)
Sets the source of synchronization signals for the node.
kSize kNet_DataOutSocketBufferSize(kNet net)
Reports the socket buffer size associated with each data output port.