reckfellENGINE

IP

Internet protocol (IP) support functions such as DNS resolution.

On this page
class IPReckfellSharp

Internet protocol (IP) support functions such as DNS resolution.

IP contains support functions for the Internet Protocol (IP). TCP/IP support is in different classes (see StreamPeerTcp and TcpServer). IP provides DNS hostname resolution support, both blocking and threaded.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Properties1

SingletonProperty
# Singleton
C#
public static IPInstance Singleton { get; }

Methods10

ClearCachevoid
# ClearCache
C#
public static void ClearCache(string hostname = "");

Removes all of a hostname's cached references. If no hostname is given, all cached IP addresses are removed.

Parameters
NameTypeDefault
hostnamestring""
EraseResolveItemvoid
# EraseResolveItem
C#
public static void EraseResolveItem(int id);

Removes a given item id from the queue. This should be used to free a queue after it has completed to enable more queries to happen.

Parameters
NameTypeDefault
idint—
GetLocalAddressesstring[]
# GetLocalAddresses
C#
public static string[] GetLocalAddresses();

Returns all the user's current IPv4 and IPv6 addresses as an array.

Returns string[]
GetLocalInterfacesReckfell.Collections.Array<Reckfell.Collections.Dictionary>
# GetLocalInterfaces
C#
public static Reckfell.Collections.Array<Reckfell.Collections.Dictionary> GetLocalInterfaces();

Returns all network adapters as an array. Each adapter is a dictionary of the form:

Text
{
    "index": "1", # Interface index.
    "name": "eth0", # Interface name.
    "friendly": "Ethernet One", # A friendly name (might be empty).
    "addresses": ["192.168.1.101"], # An array of IP addresses associated to this interface.
}
Returns Reckfell.Collections.Array<Reckfell.Collections.Dictionary>
GetResolveItemAddressstring
# GetResolveItemAddress
C#
public static string GetResolveItemAddress(int id);

Returns a queued hostname's IP address, given its queue id. Returns an empty string on error or if resolution hasn't happened yet (see IP.GetResolveItemStatus).

Parameters
NameTypeDefault
idint—
Returns string
GetResolveItemAddressesReckfell.Collections.Array
# GetResolveItemAddresses
C#
public static Reckfell.Collections.Array GetResolveItemAddresses(int id);

Returns resolved addresses, or an empty array if an error happened or resolution didn't happen yet (see IP.GetResolveItemStatus).

Parameters
NameTypeDefault
idint—
Returns Reckfell.Collections.Array
GetResolveItemStatusIP.ResolverStatus
# GetResolveItemStatus
C#
public static IP.ResolverStatus GetResolveItemStatus(int id);

Returns a queued hostname's status as a IP.ResolverStatus constant, given its queue id.

Parameters
NameTypeDefault
idint—
Returns IP.ResolverStatus
ResolveHostnamestring
# ResolveHostname
C#
public static string ResolveHostname(string host, IP.Type iPType = IP.Type.Any);

Returns a given hostname's IPv4 or IPv6 address when resolved (blocking-type method). The address type returned depends on the IP.Type constant given as ip_type.

Parameters
NameTypeDefault
hoststring—
iPTypeIP.TypeIP.Type.Any
Returns string
ResolveHostnameAddressesstring[]
# ResolveHostnameAddresses
C#
public static string[] ResolveHostnameAddresses(string host, IP.Type iPType = IP.Type.Any);

Resolves a given hostname in a blocking way. Addresses are returned as an Reckfell.Collections.Array of IPv4 or IPv6 addresses depending on ip_type.

Parameters
NameTypeDefault
hoststring—
iPTypeIP.TypeIP.Type.Any
Returns string[]
ResolveHostnameQueueItemint
# ResolveHostnameQueueItem
C#
public static int ResolveHostnameQueueItem(string host, IP.Type iPType = IP.Type.Any);

Creates a queue item to resolve a hostname to an IPv4 or IPv6 address depending on the IP.Type constant given as ip_type. Returns the queue ID if successful, or IP.ResolverInvalidId on error.

Parameters
NameTypeDefault
hoststring—
iPTypeIP.TypeIP.Type.Any
Returns int

Fields and constants2

ResolverInvalidIdField
# ResolverInvalidId
C#
public const long ResolverInvalidId = -1;

Invalid ID constant. Returned if IP.ResolverMaxQueries is exceeded.

ResolverMaxQueriesField
# ResolverMaxQueries
C#
public const long ResolverMaxQueries = 256;

Maximum number of concurrent DNS resolver queries allowed, IP.ResolverInvalidId is returned if exceeded.

IP.ResolverStatus

ValueDescription
Done = 2

DNS hostname resolver status: Done.

Error = 3

DNS hostname resolver status: Error.

None = 0

DNS hostname resolver status: No status.

Waiting = 1

DNS hostname resolver status: Waiting.

IP.Type

ValueDescription
Any = 3

Address type: Any.

Ipv4 = 1

Address type: Internet protocol version 4 (IPv4).

Ipv6 = 2

Address type: Internet protocol version 6 (IPv6).

None = 0

Address type: None.

Reckfell Engine documentationBack to top ↑
QUICK LINKSGetting startedEntity hierarchyC# & .NET 10Scenes and prefabs
Reckfell guides and full API K
reckfellENGINE
RECKFELL ACCOUNT

Sign in

Sign in to your Reckfell account.

One account for the entire Reckfell platform.