public class

TCPEndpoint

extends Object
implements Endpoint
java.lang.Object
   ↳ sun.rmi.transport.tcp.TCPEndpoint

Class Overview

TCPEndpoint represents some communication endpoint for an address space (VM).

Summary

Public Constructors
TCPEndpoint(String host, int port)
Create an endpoint for a specified host and port.
TCPEndpoint(String host, int port, RMIClientSocketFactory csf, RMIServerSocketFactory ssf)
Create a custom socket factory endpoint for a specified host and port.
Public Methods
boolean equals(Object obj)
Indicates whether some other object is "equal to" this one.
void exportObject(Target target)
Export the object to accept incoming calls.
Channel getChannel()
Returns a channel for this (remote) endpoint.
RMIClientSocketFactory getClientSocketFactory()
Get the client socket factory associated with this endpoint.
String getHost()
Returns address for endpoint
Transport getInboundTransport()
Returns the transport for incoming connections to this endpoint, if this endpoint was created as a server endpoint (using getLocalEndpoint).
int getListenPort()
Returns the port that this endpoint's inbound transport listens on, if this endpoint was created as a server endpoint (using getLocalEndpoint).
static TCPEndpoint getLocalEndpoint(int port)
Get an endpoint for the local address space on specified port.
static TCPEndpoint getLocalEndpoint(int port, RMIClientSocketFactory csf, RMIServerSocketFactory ssf)
Transport getOutboundTransport()
Returns transport for making connections to remote endpoints; (here, the default transport at port 0 is used).
int getPort()
Returns the port for this endpoint.
RMIServerSocketFactory getServerSocketFactory()
Get the server socket factory associated with this endpoint.
int hashCode()
Returns a hash code value for the object.
static TCPEndpoint read(ObjectInput in)
Get the endpoint from the input stream.
static TCPEndpoint readHostPortFormat(DataInput in)
Create a new endpoint from input stream data.
static void shedConnectionCaches()
Release idle outbound connections to reduce demand on I/O resources.
String toString()
Return string representation for endpoint.
void write(ObjectOutput out)
Write endpoint to output stream.
void writeHostPortFormat(DataOutput out)
Write endpoint to output stream in older format used by UnicastRef for JDK1.1 compatibility.
[Expand]
Inherited Methods
From class java.lang.Object
From interface sun.rmi.transport.Endpoint

Public Constructors

public TCPEndpoint (String host, int port)

Create an endpoint for a specified host and port. This should not be used by external classes to create endpoints for servers in this VM; use getLocalEndpoint instead.

public TCPEndpoint (String host, int port, RMIClientSocketFactory csf, RMIServerSocketFactory ssf)

Create a custom socket factory endpoint for a specified host and port. This should not be used by external classes to create endpoints for servers in this VM; use getLocalEndpoint instead.

Public Methods

public boolean equals (Object obj)

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.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
obj the reference object with which to compare.
Returns
  • true if this object is the same as the obj argument; false otherwise.

public void exportObject (Target target)

Export the object to accept incoming calls.

public Channel getChannel ()

Returns a channel for this (remote) endpoint.

public RMIClientSocketFactory getClientSocketFactory ()

Get the client socket factory associated with this endpoint.

public String getHost ()

Returns address for endpoint

public Transport getInboundTransport ()

Returns the transport for incoming connections to this endpoint, if this endpoint was created as a server endpoint (using getLocalEndpoint).

public int getListenPort ()

Returns the port that this endpoint's inbound transport listens on, if this endpoint was created as a server endpoint (using getLocalEndpoint). If this endpoint was created for the default/anonymous port, then this method returns zero even if the transport has started listening.

public static TCPEndpoint getLocalEndpoint (int port)

Get an endpoint for the local address space on specified port. If port number is 0, it returns shared default endpoint object whose host name and port may or may not have been determined.

public static TCPEndpoint getLocalEndpoint (int port, RMIClientSocketFactory csf, RMIServerSocketFactory ssf)

public Transport getOutboundTransport ()

Returns transport for making connections to remote endpoints; (here, the default transport at port 0 is used).

public int getPort ()

Returns the port for this endpoint. If this endpoint was created as a server endpoint (using getLocalEndpoint) for a default/anonymous port and its inbound transport has started listening, this method returns (instead of zero) the actual bound port suitable for passing to clients.

public RMIServerSocketFactory getServerSocketFactory ()

Get the server socket factory associated with this endpoint.

public int hashCode ()

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

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(Object) 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(java.lang.Object) 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 hashtables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

Returns
  • a hash code value for this object.

public static TCPEndpoint read (ObjectInput in)

Get the endpoint from the input stream.

Parameters
in the input stream
Throws
IOException If id could not be read (due to stream failure)
ClassNotFoundException

public static TCPEndpoint readHostPortFormat (DataInput in)

Create a new endpoint from input stream data.

Parameters
in the input stream
Throws
IOException

public static void shedConnectionCaches ()

Release idle outbound connections to reduce demand on I/O resources. All transports are asked to release excess connections.

public String toString ()

Return string representation for endpoint.

Returns
  • a string representation of the object.

public void write (ObjectOutput out)

Write endpoint to output stream.

Throws
IOException

public void writeHostPortFormat (DataOutput out)

Write endpoint to output stream in older format used by UnicastRef for JDK1.1 compatibility.

Throws
IOException