Zen API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kNetwork.h
Go to the documentation of this file.
1 
10 #ifndef K_API_NETWORK_H
11 #define K_API_NETWORK_H
12 
13 #include <kApi/kApiDef.h>
14 #include <kApi/Data/kString.h>
15 
25 typedef k32s kIpVersion;
26 
28 #define kIP_VERSION_4 (4)
29 
37 typedef struct kIpAddress
38 {
40  kByte address[16];
41 } kIpAddress;
42 
50 kFx(kIpAddress) kIpAddress_Any(kIpVersion version);
51 
59 
67 
76 
84 
95 kFx(kStatus) kIpAddress_Parse(kIpAddress* address, const kChar* text);
96 
106 kFx(kStatus) kIpAddress_Format(kIpAddress address, kChar* text, kSize capacity);
107 
117 
125 kFx(kBool) kIpAddress_IsLoopback(kIpAddress address);
126 
135 
143 kFx(k32u) kIpAddress_ToHost32u(kIpAddress address);
144 
152 kFx(k32u) kIpAddress_ToNet32u(kIpAddress address);
153 
161 kFx(kIpAddress) kIpAddress_FromHost32u(k32u address);
162 
170 kFx(kIpAddress) kIpAddress_FromNet32u(k32u address);
171 
180 kFx(kIpAddress) kIpAddress_Network(kIpAddress address, k32u prefixLength);
181 
191 kFx(kBool) kIpAddress_NetworkEquals(kIpAddress a, kIpAddress b, k32u prefixLength);
192 
199 typedef struct kIpEndPoint
200 {
203 } kIpEndPoint;
204 
206 #define kIP_PORT_ANY (0)
207 
210 #include <kApi/Io/kNetwork.x.h>
211 
218 //typedef kObject kNetworkInterface; --forward-declared in kApiDef.x.h
219 
228 {
229  kObj(kNetworkInterface, iface);
230  return obj->adapter;
231 }
232 
241 {
242  kObj(kNetworkInterface, iface);
243  return obj->address;
244 }
245 
254 {
255  kObj(kNetworkInterface, iface);
256  return obj->prefixLength;
257 }
258 
265 //typedef kObject kNetworkAdapter; --forward-declared in kApiDef.x.h
266 
275 {
276  kObj(kNetworkAdapter, adapter);
277  return obj->info;
278 }
279 
288 {
289  kObj(kNetworkAdapter, adapter);
290  return kString_Chars(obj->name);
291 }
292 
305 {
306  kObj(kNetworkAdapter, adapter);
307  return obj->id;
308 }
309 
321 {
322  kObj(kNetworkAdapter, adapter);
323  return obj->isUp;
324 }
325 
336 {
337  kObj(kNetworkAdapter, adapter);
338  return obj->macAddress;
339 }
340 
349 {
350  kObj(kNetworkAdapter, adapter);
351  return kArrayList_Count(obj->interfaces);
352 }
353 
363 {
364  kObj(kNetworkAdapter, adapter);
365  return kArrayList_AsT(obj->interfaces, index, kNetworkInterface);
366 }
367 
378 {
379  kObj(kNetworkAdapter, adapter);
380  return kArrayList_ItemT(obj->interfaces, index, iface);
381 }
382 
389 //typedef kObject kNetworkInfo; --forward-declared in kApiDef.x.h
390 
400 
409 
418 {
419  kObj(kNetworkInfo, info);
420  return kArrayList_Count(obj->adapters);
421 }
422 
432 {
433  kObj(kNetworkInfo, info);
434  return kArrayList_AsT(obj->adapters, index, kNetworkAdapter);
435 }
436 
445 {
446  kObj(kNetworkInfo, info);
447  return kArrayList_Count(obj->interfaces);
448 }
449 
459 {
460  kObj(kNetworkInfo, info);
461  return kArrayList_AsT(obj->interfaces, index, kNetworkInterface);
462 }
463 
473 kFx(kStatus) kNetworkInfo_FindAdapterByName(kNetworkInfo info, const kChar* name, kNetworkAdapter* adapter);
474 
485 
496 
507 
514 //typedef kObject kNetwork; --forward-declared in kApiDef.x.h
515 
536 kFx(kStatus) kNetwork_AddChangeHandler(kCallbackFx function, kPointer receiver);
537 
547 kFx(kStatus) kNetwork_RemoveChangeHandler(kCallbackFx function, kPointer receiver);
548 
561 kFx(kStatus) kNetwork_FindAdapterNameById(kSize adapterId, kChar* adapterName, kSize adapterNameCapacity);
562 
574 kFx(kStatus) kNetwork_FindAdapterIdByName(const kChar* adapterName, kSize* adapterId);
575 
588 kFx(kStatus) kNetwork_FindAdapterNameByInterface(kIpAddress interfaceAddress, kChar* adapterName, kSize adapterNameCapacity);
589 
601 kFx(kStatus) kNetwork_FindFirstAdapterInterface(const kChar* adapterName, kIpAddress* interfaceAddress);
602 
614 kFx(kStatus) kNetwork_FindInterfaceByNetwork(kIpAddress network, kIpAddress* interfaceAddress);
615 
616 #endif
Represents a 32-bit unsigned integer.
kIpAddress kIpAddress_Any(kIpVersion version)
Gets an address representing an automatically-assigned address.
kIpAddress address
IP address.
Definition: kNetwork.h:201
Represents an Internet Protocol version.
#define kArrayList_ItemT(kArrayList_list, kSize_index, TPtr_item)
Gets the value of an item.
Definition: kArrayList.h:384
Represents a void pointer.
k32u port
Port number.
Definition: kNetwork.h:202
kNetworkAdapter kNetworkInfo_AdapterAt(kNetworkInfo info, kSize index)
Gets the adapter at the specified index.
Definition: kNetwork.h:431
kBool kNetworkAdapter_IsUp(kNetworkAdapter adapter)
Gets the current status of the interface.
Definition: kNetwork.h:320
Represents network interface configuration information.
kIpAddress kIpAddress_Loopback(kIpVersion version)
Gets the loopback address.
kStatus kNetworkInfo_FindAdapterByName(kNetworkInfo info, const kChar *name, kNetworkAdapter *adapter)
Finds an adapter by name.
Declares the kString class.
kStatus kNetwork_FindInterfaceByNetwork(kIpAddress network, kIpAddress *interfaceAddress)
Finds the first interface address with subnet configuration that is compatible with the specified add...
Represents an unsigned integer that can store a pointer address.
Abstract base class for memory allocator types.
kIpAddress kIpAddress_Network(kIpAddress address, k32u prefixLength)
Extracts the network portion of an address.
kStatus kNetwork_FindAdapterNameById(kSize adapterId, kChar *adapterName, kSize adapterNameCapacity)
Finds the adapter name associated with a unique numeric adapter identifier.
#define kInlineFx(TYPE)
Inline method declaration helper.
Definition: kApiDef.h:26
Represents an IP address.
Definition: kNetwork.h:37
kNetworkAdapter kNetworkInterface_Adapter(kNetworkInterface iface)
Gets the adapter associated with this interface.
Definition: kNetwork.h:227
Represents a single unit (byte) in a UTF-8 character.
Represents a byte on the current platform.
kStatus kNetworkInfo_FindInterfaceByAddress(kNetworkInfo info, kIpAddress address, kNetworkInterface *iface)
Finds an interface by its exact local address.
kStatus kNetworkAdapter_InterfaceItem(kNetworkAdapter adapter, kSize index, kNetworkInterface *iface)
Gets the interface at the specified index, if present.
Definition: kNetwork.h:377
Represents network adapter configuration information.
kStatus kIpAddress_Format(kIpAddress address, kChar *text, kSize capacity)
Formats an IP address as a string.
kSize kNetworkAdapter_Id(kNetworkAdapter adapter)
Gets the unique numeric ID associated with this adapter object.
Definition: kNetwork.h:304
kIpAddress kIpAddress_BroadcastV4()
Gets an address suitable for broadcasting IPv4 datagrams.
kStatus kNetwork_FindAdapterNameByInterface(kIpAddress interfaceAddress, kChar *adapterName, kSize adapterNameCapacity)
Finds the adapter name associated with the specified interface address.
kIpAddress kNetworkInterface_Address(kNetworkInterface iface)
Gets the IP address associated with this interface.
Definition: kNetwork.h:240
kStatus kNetworkInfo_Construct(kNetworkInfo *info, kAlloc alloc)
Constructs a network info object describing the current state of any local network adapters...
#define kObj(TypeName_T, T_object)
Declares a local "obj" (this-pointer) variable and initializes it from a type-checked object handle...
Definition: kApiDef.h:3383
kStatus kNetwork_RemoveChangeHandler(kCallbackFx function, kPointer receiver)
Removes a network change notification handler.
kBool kIpAddress_Equals(kIpAddress a, kIpAddress b)
Compares two addresses for equality.
kNetworkInfo kNetworkAdapter_Info(kNetworkAdapter adapter)
Gets the network info object that owns this adapter object.
Definition: kNetwork.h:274
k32u kIpAddress_ToNet32u(kIpAddress address)
Converts an IPv4 address to a network-endian 32-bit integer.
kStatus kNetworkInfo_FindAdapterById(kNetworkInfo info, kSize id, kNetworkAdapter *adapter)
Finds an adapter by its unique numeric identifier.
kBool kIpAddress_NetworkEquals(kIpAddress a, kIpAddress b, k32u prefixLength)
Compares two addresses for network equality.
kSize kNetworkInfo_AdapterCount(kNetworkInfo info)
Reports the number of network adapters.
Definition: kNetwork.h:417
kChar * kString_Chars(kString str)
Returns a pointer to the internal character buffer.
Definition: kString.h:247
kStatus kNetwork_AddChangeHandler(kCallbackFx function, kPointer receiver)
Add a network change notification handler.
Core Zen type declarations.
kSize kArrayList_Count(kArrayList list)
Returns the current count of items in the list.
Definition: kArrayList.h:638
Represents a 32-bit signed integer.
Represents an Ethernet address.
Definition: kApiDef.h:1704
kBool kIpAddress_IsLoopback(kIpAddress address)
Reports whether the given address is a loopback address.
Represents network configuration information.
kNetworkInterface kNetworkInfo_InterfaceAt(kNetworkInfo info, kSize index)
Gets the interface at the specified index.
Definition: kNetwork.h:458
#define kArrayList_AsT(kArrayList_list, kSize_index, T)
Gets the value of an item.
Definition: kArrayList.h:417
kStatus(kCall * kCallbackFx)(kPointer receiver, kPointer sender, void *args)
Callback signature for a generic event handler.
Definition: kApiDef.h:1806
kIpAddress kIpAddress_LoopbackV4()
Gets the IpV4 loopback address.
kMacAddress kNetworkAdapter_MacAddress(kNetworkAdapter adapter)
Gets the current MAC address of the interface.
Definition: kNetwork.h:335
kSize kNetworkAdapter_InterfaceCount(kNetworkAdapter adapter)
Reports the number of interfaces associated with this adapter.
Definition: kNetwork.h:348
kIpVersion version
Address version.
Definition: kNetwork.h:39
kBool kIpAddress_IsLinkLocal(kIpAddress address)
Reports whether the given address is a link-local address.
kIpAddress kIpAddress_AnyV4()
Gets an address representing an automatically-assigned IPv4 address.
kStatus kIpAddress_Parse(kIpAddress *address, const kChar *text)
Parses a text-formatted IP address.
Represents an error code.
Represents an IP end point (address, port).
Definition: kNetwork.h:199
kIpAddress kIpAddress_FromHost32u(k32u address)
Converts a host-endian 32-bit integer to an IPv4 address.
kSize kNetworkInfo_InterfaceCount(kNetworkInfo info)
Reports the total number of network interfaces across all adapters.
Definition: kNetwork.h:444
kNetworkInterface kNetworkAdapter_InterfaceAt(kNetworkAdapter adapter, kSize index)
Gets the interface at the specified index.
Definition: kNetwork.h:362
kStatus kNetwork_FindAdapterIdByName(const kChar *adapterName, kSize *adapterId)
Finds the unique numeric adapter identifier associated with an adapter name.
k32u kIpAddress_ToHost32u(kIpAddress address)
Converts an IPv4 address to a host-endian 32-bit integer.
Represents a boolean value.
k32u kNetworkInterface_PrefixLength(kNetworkInterface iface)
Gets the subnet prefix length associated with this interface.
Definition: kNetwork.h:253
const kChar * kNetworkAdapter_Name(kNetworkAdapter adapter)
Gets the name associated with this adapter object.
Definition: kNetwork.h:287
kStatus kNetwork_FindFirstAdapterInterface(const kChar *adapterName, kIpAddress *interfaceAddress)
Finds the first interface address associated with an adapter name.
kStatus kNetworkInfo_FindInterfaceByNetwork(kNetworkInfo info, kIpAddress address, kNetworkInterface *iface)
Finds the first interface with subnet configuration that is compatible with the specified address...
kStatus kNetworkInfo_Refresh(kNetworkInfo info)
Updates network information.
kIpAddress kIpAddress_FromNet32u(k32u address)
Converts a network-endian 32-bit integer to an IPv4 address.