maxon.NetworkIpAddrInterface

Description

This class represents an Internet Protocol (IP) address.

It is version agnostic and supports both IPv4 and IPv6.

Inheritance diagram

Inheritance

Parent Class:

• maxon.ObjectInterface

Children Classes:

• maxon.NetworkIpAddrPortInterface

• maxon.NetworkIpAddr

Methods Signature

Flush()	Deprecated since version 20.
GetNativeProtocol()	Returns the type of the IP address used in this object.
GetProtocol()	Returns the type of the IP address used in this object.
GetString([port])	Retrieves the string representation of the current IP address.
SetIPv4()	Sets an IP v4 address from the native in_addr structure.
SetIPv6()	Sets an IP v6 address from the native in_addr structure.
__repr__()	Returns the string representation of an NetworkIpAddr using the NetworkIpAddrInterface.GetString method.

Methods Definition

NetworkIpAddrInterface.Flush()

Deprecated since version 20: Use NetworkIpAddrInterface.Reset() instead.

NetworkIpAddrInterface.GetNativeProtocol()

Returns the type of the IP address used in this object.

Returns

The Protocol type.

Return type

int

NetworkIpAddrInterface.GetProtocol()

Returns the type of the IP address used in this object.

Returns

The IP address type.

Return type

maxon.PROTOCOL

NetworkIpAddrInterface.GetString(port=0)

Retrieves the string representation of the current IP address.

Parameters

port (int) – The port to be appended at the end of the IP address.

Returns

The string representation of the current IP address.

Return type

str

NetworkIpAddrInterface.SetIPv4()

Sets an IP v4 address from the native in_addr structure.

NetworkIpAddrInterface.SetIPv6()

Sets an IP v6 address from the native in_addr structure.

NetworkIpAddrInterface.__repr__()

Returns the string representation of an NetworkIpAddr using the NetworkIpAddrInterface.GetString method.

Return type

str