java::net::Inet4Address Class Reference

Inheritance diagram for java::net::Inet4Address:

Inheritance graph
java::net::InetAddressjava::lang::Object
[legend]
Collaboration diagram for java::net::Inet4Address:

Collaboration graph
java::net::InetAddressjava::lang::Objectjava::lang::Stringjava::lang::Interfacejava::lang::ObjectRefjava::lang::Comparable
[legend]

List of all members.


Detailed Description

This class represents an Internet Protocol version 4 (IPv4) address.

Defined by RFC 790: Assigned Numbers, RFC 1918: Address Allocation for Private Internets, and RFC 2365: Administratively Scoped IP Multicast

Textual representation of IP addresses

Textual representation of IPv4 address used as input to methods takes one of the following forms:

<blockquote>
d.d.d.d
d.d.d
d.d
d
</blockquote>

When four parts are specified, each is interpreted as a byte of data and assigned, from left to right, to the four bytes of an IPv4 address.

When a three part address is specified, the last part is interpreted as a 16-bit quantity and placed in the right most two bytes of the network address. This makes the three part address format convenient for specifying Class B net- work addresses as 128.net.host.

When a two part address is supplied, the last part is interpreted as a 24-bit quantity and placed in the right most three bytes of the network address. This makes the two part address format convenient for specifying Class A network addresses as net.host.

When only one part is given, the value is stored directly in the network address without any byte rearrangement.

For methods that return a textual representation as output value, the first form, i.e. a dotted-quad string, is used.

The Scope of a Multicast Address

Historically the IPv4 TTL field in the IP header has doubled as a multicast scope field: a TTL of 0 means node-local, 1 means link-local, up through 32 means site-local, up through 64 means region-local, up through 128 means continent-local, and up through 255 are global. However, the administrative scoping is preferred. Please refer to RFC 2365: Administratively Scoped IP Multicast

Public Member Functions

 Inet4Address ()
 Inet4Address (const String &hostName, const Array< jbyte > &addr)
virtual jboolean isMulticastAddress () const
 Utility routine to check if the InetAddress is an IP multicast address.
virtual jboolean isAnyLocalAddress () const
 Utility routine to check if the InetAddress in a wildcard address.
virtual jboolean isLoopbackAddress () const
 Utility routine to check if the InetAddress is a loopback address.
virtual jboolean isLinkLocalAddress () const
 Utility routine to check if the InetAddress is an link local address.
virtual jboolean isSiteLocalAddress () const
 Utility routine to check if the InetAddress is a site local address.
virtual jboolean isMCGlobal () const
 Utility routine to check if the multicast address has global scope.
virtual jboolean isMCNodeLocal () const
 Utility routine to check if the multicast address has node scope.
virtual jboolean isMCLinkLocal () const
 Utility routine to check if the multicast address has link scope.
virtual jboolean isMCSiteLocal () const
 Utility routine to check if the multicast address has site scope.
virtual jboolean isMCOrgLocal () const
 Utility routine to check if the multicast address has organization scope.
String getHostAddress () const
 Returns the IP address string in textual presentation form.

Static Public Member Functions

static String numericToTextFormat (const Array< jbyte > &address)
static Ref< Array
< jbyte > > 
textToNumericFormat (const String &src)

Static Public Attributes

static const jint INADDRSZ


Constructor & Destructor Documentation

java::net::Inet4Address::Inet4Address (  ) 

java::net::Inet4Address::Inet4Address ( const String hostName,
const Array< jbyte > &  addr 
)


Member Function Documentation

static String java::net::Inet4Address::numericToTextFormat ( const Array< jbyte > &  address  )  [static]

static Ref<Array<jbyte> > java::net::Inet4Address::textToNumericFormat ( const String src  )  [static]

virtual jboolean java::net::Inet4Address::isMulticastAddress (  )  const [virtual]

Utility routine to check if the InetAddress is an IP multicast address.

IP multicast address is a Class D address i.e first four bits of the address are 1110.

Returns:
a boolean indicating if the InetAddress is an IP multicast address
Since:
JDK1.1

Reimplemented from java::net::InetAddress.

virtual jboolean java::net::Inet4Address::isAnyLocalAddress (  )  const [virtual]

Utility routine to check if the InetAddress in a wildcard address.

Returns:
a boolean indicating if the Inetaddress is a wildcard address.
Since:
1.4

Reimplemented from java::net::InetAddress.

virtual jboolean java::net::Inet4Address::isLoopbackAddress (  )  const [virtual]

Utility routine to check if the InetAddress is a loopback address.

Returns:
a boolean indicating if the InetAddress is a loopback address; or false otherwise.
Since:
1.4

Reimplemented from java::net::InetAddress.

virtual jboolean java::net::Inet4Address::isLinkLocalAddress (  )  const [virtual]

Utility routine to check if the InetAddress is an link local address.

Returns:
a boolean indicating if the InetAddress is a link local address; or false if address is not a link local unicast address.
Since:
1.4

Reimplemented from java::net::InetAddress.

virtual jboolean java::net::Inet4Address::isSiteLocalAddress (  )  const [virtual]

Utility routine to check if the InetAddress is a site local address.

Returns:
a boolean indicating if the InetAddress is a site local address; or false if address is not a site local unicast address.
Since:
1.4

Reimplemented from java::net::InetAddress.

virtual jboolean java::net::Inet4Address::isMCGlobal (  )  const [virtual]

Utility routine to check if the multicast address has global scope.

Returns:
a boolean indicating if the address has is a multicast address of global scope, false if it is not of global scope or it is not a multicast address
Since:
1.4

Reimplemented from java::net::InetAddress.

virtual jboolean java::net::Inet4Address::isMCNodeLocal (  )  const [virtual]

Utility routine to check if the multicast address has node scope.

Returns:
a boolean indicating if the address has is a multicast address of node-local scope, false if it is not of node-local scope or it is not a multicast address
Since:
1.4

Reimplemented from java::net::InetAddress.

virtual jboolean java::net::Inet4Address::isMCLinkLocal (  )  const [virtual]

Utility routine to check if the multicast address has link scope.

Returns:
a boolean indicating if the address has is a multicast address of link-local scope, false if it is not of link-local scope or it is not a multicast address
Since:
1.4

Reimplemented from java::net::InetAddress.

virtual jboolean java::net::Inet4Address::isMCSiteLocal (  )  const [virtual]

Utility routine to check if the multicast address has site scope.

Returns:
a boolean indicating if the address has is a multicast address of site-local scope, false if it is not of site-local scope or it is not a multicast address
Since:
1.4

Reimplemented from java::net::InetAddress.

virtual jboolean java::net::Inet4Address::isMCOrgLocal (  )  const [virtual]

Utility routine to check if the multicast address has organization scope.

Returns:
a boolean indicating if the address has is a multicast address of organization-local scope, false if it is not of organization-local scope or it is not a multicast address
Since:
1.4

Reimplemented from java::net::InetAddress.

String java::net::Inet4Address::getHostAddress (  )  const [virtual]

Returns the IP address string in textual presentation form.

Returns:
the raw IP address in a string format.
Since:
JDK1.0.2

Reimplemented from java::net::InetAddress.


Member Data Documentation

const jint java::net::Inet4Address::INADDRSZ [static]


The documentation for this class was generated from the following file:
Generated on Fri May 16 11:56:43 2008 for CrossPlatformJavaLikeC++API by  doxygen 1.5.3