com.sun.sgs.impl.io

Class SocketEndpoint

java.lang.Object

com.sun.sgs.impl.io.SocketEndpoint

All Implemented Interfaces:

Endpoint<SocketAddress>

public class SocketEndpoint
extends Object
implements Endpoint<SocketAddress>

An implementation of Endpoint that wraps a SocketAddress.

Field Summary

Fields

Modifier and Type	Field and Description
protected SocketAddress	address The socket address this endpoint encapsulates.
protected Executor	executor The Executor used by this endpoint's connector or acceptor.
protected int	numProcessors A MINA configuration parameter whose value may affect performance.
protected TransportType	transportType The transport type this endpoint encapsulates.

Constructor Summary

Constructors

Constructor and Description
SocketEndpoint(SocketAddress address, TransportType type) Constructs a SocketEndpoint with the given TransportType.
SocketEndpoint(SocketAddress address, TransportType type, Executor executor) Constructs a SocketEndpoint with the given TransportType using the given Executor for thread management.
SocketEndpoint(SocketAddress address, TransportType type, Executor executor, int numProcessors) Constructs a SocketEndpoint with the given TransportType using the given Executor for thread management.

Method Summary

Methods

Modifier and Type	Method and Description
Connector<SocketAddress>	createConnector() Creates a Connector for actively initiating a connection to this remote Endpoint.
SocketAddress	getAddress() Returns the SocketAddress encapsulated by this endpoint.
Executor	getExecutor() Returns the Executor encapsulated by this endpoint.
int	getNumProcessors() Returns the number of processors available to the MINA framework.
TransportType	getTransportType() Returns the TransportType encapsulated by this endpoint.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.sun.sgs.io.Endpoint

getAddress

Field Detail

address

protected final SocketAddress address

The socket address this endpoint encapsulates.

transportType

protected final TransportType transportType

The transport type this endpoint encapsulates.

executor

protected final Executor executor

The Executor used by this endpoint's connector or acceptor.

numProcessors

protected final int numProcessors

A MINA configuration parameter whose value may affect performance.

Constructor Detail

SocketEndpoint

public SocketEndpoint(SocketAddress address,
              TransportType type)

Constructs a SocketEndpoint with the given TransportType. This is the simplest way to create a SocketEndpoint. The returned endpoint will use new daemon threads as necessary for processing events.

Parameters:

address - the socket address to encapsulate

type - the type of transport

SocketEndpoint

public SocketEndpoint(SocketAddress address,
              TransportType type,
              Executor executor)

Constructs a SocketEndpoint with the given TransportType using the given Executor for thread management.

Parameters:

address - the socket address to encapsulate

type - the type of transport

executor - an Executor specifying the threading policy

SocketEndpoint

public SocketEndpoint(SocketAddress address,
              TransportType type,
              Executor executor,
              int numProcessors)

Constructs a SocketEndpoint with the given TransportType using the given Executor for thread management. The numProcessors parameter refers to the number of MINA SocketIOProcessors to initially create. numProcessors must be greater than 0.

(Note: A SocketIOProcessor is a MINA implementation detail that controls the internal processing of the IO. It is exposed here to allow clients the option to configure this value, which may aid performance tuning).

Parameters:

address - the socket address to encapsulate

type - the type of transport

executor - An Executor specifying the threading policy

numProcessors - the number of processors available on this system. This value must be greater than 0.

Throws:

IllegalArgumentException - if numProcessors is zero or negative.

Method Detail

createConnector

public Connector<SocketAddress> createConnector()

Creates a Connector for actively initiating a connection to this remote Endpoint.

Specified by:

createConnector in interface Endpoint<SocketAddress>

Returns:

a Connector configured to connect to this Endpoint

getAddress

public SocketAddress getAddress()

Returns the SocketAddress encapsulated by this endpoint.

Returns:

the SocketAddress encapsulated by this endpoint

getTransportType

public TransportType getTransportType()

Returns the TransportType encapsulated by this endpoint.

Returns:

the TransportType encapsulated by this endpoint

getExecutor

public Executor getExecutor()

Returns the Executor encapsulated by this endpoint.

Returns:

the Executor encapsulated by this endpoint

getNumProcessors

public int getNumProcessors()

Returns the number of processors available to the MINA framework.

Returns:

the number of processors available to the MINA framework

toString

public String toString()

Overrides:

toString in class Object