Top Description Fields Constructors Methods
jnr.unixsocket

public Class UnixSocketAddress

extends SocketAddress
Class Inheritance
Imports
java.io.IOException, .ObjectInputStream, .ObjectOutputStream, jnr.constants.platform.ProtocolFamily

This class represents an AF_UNIX-style socket address. On Linux, it supports the platform-specific abstract name space.

Using an abstract name space is denoted by the socket path starting with a NUL byte. Sockets in abstract name space have no entry in the file system. When linux performs autobind, it constructs the resulting path with a leading NUL, followed by a unique 5-digit hexadecimal number.

Field Summary

Modifier and TypeField and Description
private transient SockAddrUnix
private static final long

Constructor Summary

AccessConstructor and Description
pack-priv
public
public

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
_other
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
pack-priv SockAddrUnix
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.
public String

Returns:

The human readable path of this address.
humanReadablePath
()

Returns a human readable path.

pack-priv int
public String

Returns:

The path of this AF_UNIX address.

Note

On Linux, can contain a leading NUL byte, if this address resides in abstract namespace.

path
()

Retrieves the path.

private void
public String

Returns:

The human readable description of this address.
toString
()

Overrides java.lang.Object.toString.

Retrieves a human readable description of this address.
private void

Field Detail

addressback to summary
private transient SockAddrUnix address
serialVersionUIDback to summary
private static final long serialVersionUID

Hides java.net.SocketAddress.serialVersionUID.

Constructor Detail

UnixSocketAddressback to summary
pack-priv UnixSocketAddress()
UnixSocketAddressback to summary
public UnixSocketAddress(File path)
UnixSocketAddressback to summary
public UnixSocketAddress(final String path)

Method Detail

equalsback to summary
public boolean equals(Object _other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
_other:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getStructback to summary
pack-priv SockAddrUnix getStruct()
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
humanReadablePathback to summary
public String humanReadablePath()

Returns a human readable path. On Linux, AF_UNIX sockets can be bound/connected in abstract namespace. This is denoted by a leading NUL byte in the path. In order to be properly displayed, this method returns a path prefixed by '@' like netstat, lsof an similar tools.

Returns:String

The human readable path of this address.

lengthback to summary
pack-priv int length()
pathback to summary
public String path()

Retrieves the path.

Returns:String

The path of this AF_UNIX address.

Note

On Linux, can contain a leading NUL byte, if this address resides in abstract namespace.

readObjectback to summary
private void readObject(ObjectInputStream o) throws IOException, ClassNotFoundException
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Retrieves a human readable description of this address.

Returns:String

The human readable description of this address.

Annotations
@Override
writeObjectback to summary
private void writeObject(ObjectOutputStream o) throws IOException