Package zipkin2

Class Endpoint

java.lang.Object

zipkin2.Endpoint

All Implemented Interfaces:

Serializable

public final class Endpoint
extends Object
implements Serializable

The network context of a node in the service graph.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Endpoint.Builder

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	hashCode()
String	ipv4()	The text representation of the primary IPv4 address associated with this a connection.
byte[]	ipv4Bytes()	IPv4 endpoint address packed into 4 bytes or null if unknown.
String	ipv6()	The text representation of the primary IPv6 address associated with this a connection.
byte[]	ipv6Bytes()	IPv6 endpoint address packed into 16 bytes or null if unknown.
static Endpoint.Builder	newBuilder()
Integer	port()	Port of the IP's socket or null, if not known.
int	portAsInt()	Like port() except returns a primitive where zero implies absent.
String	serviceName()	Lower-case label of this node in the service graph, such as "favstar".
Endpoint.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

serviceName

@Nullable public String serviceName()

Lower-case label of this node in the service graph, such as "favstar". Leave absent if unknown.

This is a primary label for trace lookup and aggregation, so it should be intuitive and consistent. Many use a name from service discovery.

ipv4

@Nullable public String ipv4()

The text representation of the primary IPv4 address associated with this a connection. Ex. 192.168.99.100 Absent if unknown.

ipv4Bytes

@Nullable public byte[] ipv4Bytes()

IPv4 endpoint address packed into 4 bytes or null if unknown.

See Also:

ipv6(), Inet4Address.getAddress()

ipv6

@Nullable public String ipv6()

The text representation of the primary IPv6 address associated with this a connection. Ex. 2001:db8::c001 Absent if unknown.

See Also:

for mapped addresses, ipv6Bytes()

ipv6Bytes

@Nullable public byte[] ipv6Bytes()

IPv6 endpoint address packed into 16 bytes or null if unknown.

See Also:

ipv6(), Inet6Address.getAddress()

port

@Nullable public Integer port()

Port of the IP's socket or null, if not known.

See Also:

InetSocketAddress.getPort()

portAsInt

public int portAsInt()

Like port() except returns a primitive where zero implies absent.

Using this method will avoid allocation, so is encouraged when copying data.

toBuilder

public Endpoint.Builder toBuilder()

newBuilder

public static Endpoint.Builder newBuilder()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object