FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kNetInterface.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_NET_INTERFACE_H
9 #define K_FIRESYNC_NET_INTERFACE_H
10 
11 #include <kFireSync/kNodeDef.h>
12 
19 //typedef kObject kNetInterface; --forward-declared in kFsDef.x.h
20 
28 kFsFx(kStatus) kNetInterface_Clear(kNetInterface netInterface);
29 
38 kFsFx(kStatus) kNetInterface_ClearAll(kNetInterface netInterface, kBool clearIpConfig);
39 
47 kFsFx(kNetworkSpeed) kNetInterface_Speed(kNetInterface netInterface);
48 
56 kFsFx(kNetworkSpeed) kNetInterface_NextSpeed(kNetInterface netInterface);
57 
69 kFsFx(kStatus) kNetInterface_SetNextSpeed(kNetInterface netInterface, kNetworkSpeed speed);
70 
79 kFsFx(kStatus) kNetInterface_NextSpeedInfo(kNetInterface netInterface, kInfoBits* info);
80 
92 kFsFx(k32u) kNetInterface_TransmitRate(kNetInterface netInterface);
93 
102 kFsFx(kStatus) kNetInterface_SetTransmitRate(kNetInterface netInterface, k32u rate);
103 
112 kFsFx(kStatus) kNetInterface_TransmitRateInfo(kNetInterface netInterface, kInfo32u* info);
113 
121 kFsFx(const kIpConfig*) kNetInterface_IpConfig(kNetInterface netInterface);
122 
130 kFsFx(const kIpConfig*) kNetInterface_NextIpConfig(kNetInterface netInterface);
131 
143 kFsFx(kStatus) kNetInterface_SetNextIpConfig(kNetInterface netInterface, const kIpConfig* config);
144 
152 kFsFx(kMacAddress) kNetInterface_MacAddress(kNetInterface netInterface);
153 
154 #include <kFireSync/Client/kNetInterface.x.h>
155 
156 #endif
kNetInterface::kNetInterface_TransmitRateInfo
kStatus kNetInterface_TransmitRateInfo(kNetInterface netInterface, kInfo32u *info)
Reports constraint and validity information for the maximum transmit rate setting.
kNetInterface::kNetInterface_Speed
kNetworkSpeed kNetInterface_Speed(kNetInterface netInterface)
Gets the current network interface speed configuration.
kInfoBits
Represents constraint and validity information for a bit flag setting.
Definition: kInfo.h:544
kNetInterface::kNetInterface_Clear
kStatus kNetInterface_Clear(kNetInterface netInterface)
Resets network interface mode settings to defaults.
kNetInterface::kNetInterface_IpConfig
const kIpConfig * kNetInterface_IpConfig(kNetInterface netInterface)
Gets the current node IP configuration.
kIpConfig
Represents address configuration for an Internet Protocol adapter.
Definition: kFsDef.h:157
kNetInterface::kNetInterface_ClearAll
kStatus kNetInterface_ClearAll(kNetInterface netInterface, kBool clearIpConfig)
Resets network interface mode and device settings to defaults.
kNodeDef.h
Essential declarations related to FireSync nodes.
kNetInterface::kNetInterface_NextIpConfig
const kIpConfig * kNetInterface_NextIpConfig(kNetInterface netInterface)
Reports the IP configuration that will take effect after reset.
kNetInterface::kNetInterface_SetTransmitRate
kStatus kNetInterface_SetTransmitRate(kNetInterface netInterface, k32u rate)
Sets the maximum network interface transmission rate.
kNetInterface::kNetInterface_SetNextIpConfig
kStatus kNetInterface_SetNextIpConfig(kNetInterface netInterface, const kIpConfig *config)
Sets the IP configuration that will take effect after reset.
kNetInterface::kNetInterface_NextSpeed
kNetworkSpeed kNetInterface_NextSpeed(kNetInterface netInterface)
Reports the network interface speed configuration that will take effect after reset.
kNetInterface
Represents configuration for network interfaces.
kNetInterface::kNetInterface_TransmitRate
k32u kNetInterface_TransmitRate(kNetInterface netInterface)
Reports the configured maximum network interface transmission rate.
kNetInterface::kNetInterface_SetNextSpeed
kStatus kNetInterface_SetNextSpeed(kNetInterface netInterface, kNetworkSpeed speed)
Sets the network interface speed configuration that will take effect after reset. ...
kInfo32u
Represents constraint and validity information for a 32-bit unsigned integer setting.
Definition: kInfo.h:98
kNetInterface::kNetInterface_MacAddress
kMacAddress kNetInterface_MacAddress(kNetInterface netInterface)
Gets the current node MAC address.
kNetInterface::kNetInterface_NextSpeedInfo
kStatus kNetInterface_NextSpeedInfo(kNetInterface netInterface, kInfoBits *info)
Reports constraint and validity information for the NextSpeed setting.
kNetworkSpeed
Represents a network speed.