Package org.opensearch.core.common.transport

Class TransportAddress

java.lang.Object

org.opensearch.core.common.transport.TransportAddress

All Implemented Interfaces:

Writeable, ToXContent, ToXContentFragment

@PublicApi(since="1.0.0")
public final class TransportAddress
extends Object
implements Writeable, ToXContentFragment

A transport address used for IP socket address (wraps InetSocketAddress).

Opensearch.api:

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.core.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.WriteableRegistry, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final InetAddress	META_ADDRESS	A non-routeable v4 meta transport address that can be used for testing or in scenarios where targets should be marked as non-applicable from a transport perspective.

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
TransportAddress(InetAddress address, int port)
TransportAddress(InetSocketAddress address)	Creates a new TransportAddress from a InetSocketAddress.
TransportAddress(StreamInput in)	Creates a new TransportAddress from a StreamInput.

Method Summary

Modifier and Type	Method	Description
InetSocketAddress	address()	Returns the enclosed InetSocketAddress
boolean	equals(Object o)
String	getAddress()	Returns a string representation of the enclosed InetSocketAddress
int	getPort()	Returns the addresses port
int	hashCode()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opensearch.core.xcontent.ToXContentFragment

isFragment

Field Details

META_ADDRESS

public static final InetAddress META_ADDRESS

A non-routeable v4 meta transport address that can be used for testing or in scenarios where targets should be marked as non-applicable from a transport perspective.

Constructor Details

TransportAddress

public TransportAddress(InetAddress address,
 int port)

TransportAddress

public TransportAddress(InetSocketAddress address)

Creates a new TransportAddress from a InetSocketAddress.

Parameters:

address - the address to wrap

Throws:

IllegalArgumentException - if the address is null or not resolved

See Also:

• InetSocketAddress.getAddress()

TransportAddress

public TransportAddress(StreamInput in)
                 throws IOException

Creates a new TransportAddress from a StreamInput.

Parameters:

in - the stream to read from

Throws:

IOException - if an I/O error occurs

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

getAddress

public String getAddress()

Returns a string representation of the enclosed InetSocketAddress

See Also:

• NetworkAddress.format(InetAddress)

getPort

public int getPort()

Returns the addresses port

Returns:

the port number, or 0 if the socket is not bound yet.

See Also:

• InetSocketAddress.getPort()

address

public InetSocketAddress address()

Returns the enclosed InetSocketAddress

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException