org.objectweb.jonathan.apis.protocols.ip
Interface TcpIpConnectionMgr

All Known Implementing Classes:

IPv4ConnectionFactory, JConnectionMgr, JConnectionMgr

public interface TcpIpConnectionMgr

This interface defines a type for Tcp/Ip connection managers.

Method Summary

java.lang.String	getCanonicalHostName(java.lang.String hostname) Returns the canonical host name of the provided host.
IpConnection	newCltConnection(java.lang.String host, int port, IpSession session) Returns a new client connection.
TcpIpSrvConnectionFactory	newSrvConnectionFactory(int port) Returns a new server connection factory encapsulating a server socket on the provided port.

Method Detail

newCltConnection

IpConnection newCltConnection(java.lang.String host,
                              int port,
                              IpSession session)
                              throws JonathanException

Returns a new client connection.

This method is called by a protocol. The protocol provides a session (i.e. an object representing an abstract communication channel) and expects a connection (i.e. a communication resource). The returned connection must have been built using the provided session, or be a connection associated with a session having the same destination as the provided session.

Parameters:

host - the host name of the distant server;

port - the port number of a server socket on that host;

session - a TcpIp session

Returns:

a connection for that session.

Throws:

JonathanException - if an error occurs.

newSrvConnectionFactory

TcpIpSrvConnectionFactory newSrvConnectionFactory(int port)
                                                  throws JonathanException

Returns a new server connection factory encapsulating a server socket on the provided port. If port = 0, an anonymous server socket is opened.

Parameters:

port - the expected port of the server socket;

Returns:

a server connection factory.

Throws:

JonathanException - if an error occurs.

getCanonicalHostName

java.lang.String getCanonicalHostName(java.lang.String hostname)

Returns the canonical host name of the provided host. The purpose of this method is to help checking the equality of two host names. Two names corresponding to the same host should have the same (the "sameness" being defined by the equals method on type String) canonical names.

Parameters:

hostname - a host name

Returns:

the corresponding canonical host name.