org.eclipse.scada.core.client.net

Class ConnectionBase

java.lang.Object

org.eclipse.scada.core.client.net.ConnectionBase

All Implemented Interfaces:

Connection

Direct Known Subclasses:

SessionConnectionBase

public abstract class ConnectionBase
extends java.lang.Object
implements Connection

Field Summary

Fields

Modifier and Type	Field and Description
protected Messenger	messenger
protected IoSession	session
protected StatisticsImpl	statistics

Constructor Summary

Constructors

Constructor and Description
ConnectionBase(ConnectionInformation connectionInformation)

Method Summary

Methods

Modifier and Type	Method and Description
void	addConnectionStateListener(ConnectionStateListener connectionStateListener)
void	cancelConnection() Cancel an open connection ...
void	connect() Start the connection
void	connect(CallbackHandler callbackHandler) Start the connection with a callback handler
protected void	connectFailed(ConnectFuture future, java.lang.Throwable e) called when a connection attempt failed
void	disconnect() request a disconnect
protected void	disconnect(java.lang.Throwable error) request a disconnect
void	dispose() Dispose the connection
void	exceptionCaught(IoSession session, java.lang.Throwable cause)
protected void	finalize()
ConnectionInformation	getConnectionInformation()
int	getConnectTimeout() get the timeout used for connecting to the remote host
protected java.lang.Integer	getIntProperty(java.lang.String propertyName, java.lang.Integer defaultValue)
int	getMessageTimeout()
int	getPingPeriod()
java.util.Map<java.lang.String,java.lang.String>	getSessionProperties() Return the session properties as provided by the server.
java.lang.Integer	getSocketReceiveBufferSize()
java.lang.Integer	getSocketSendBufferSize()
ConnectionState	getState() Get the current connection state
java.util.Collection<StatisticEntry>	getStatistics()
boolean	isConnected()
void	messageReceived(IoSession session, java.lang.Object message)
void	messageSent(IoSession session, java.lang.Object message)
protected void	onConnectionBound()
protected void	onConnectionClosed()
protected void	onConnectionEstablished()
protected void	performConnect()
protected void	performLookup()
void	removeConnectionStateListener(ConnectionStateListener connectionStateListener)
protected void	resolvedRemoteAddress(java.net.SocketAddress address, java.lang.Throwable e)
void	sessionClosed(IoSession session)
void	sessionCreated(IoSession session)
void	sessionIdle(IoSession session, IdleStatus status)
void	sessionOpened(IoSession session)
void	setBound(java.util.Properties properties) Set the ConnectionState.BOUND including the session properties
void	setCallbackFactory(CallbackFactory callbackFactory)
protected void	setupConnector(ConnectionInformation connectionInformation, IoConnector connector)
protected void	switchState(ConnectionState state, java.lang.Throwable error, java.util.Map<java.lang.String,java.lang.String> properties)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.scada.core.client.Connection

addPrivilegeListener, getPrivileges, removePrivilegeListener

Field Detail

session

protected volatile IoSession session

messenger

protected final Messenger messenger

statistics

protected final StatisticsImpl statistics

Constructor Detail

ConnectionBase

public ConnectionBase(ConnectionInformation connectionInformation)

Method Detail

setCallbackFactory

public void setCallbackFactory(CallbackFactory callbackFactory)

Specified by:

setCallbackFactory in interface Connection

switchState

protected void switchState(ConnectionState state,
               java.lang.Throwable error,
               java.util.Map<java.lang.String,java.lang.String> properties)

disconnect

public void disconnect()

request a disconnect

Specified by:

disconnect in interface Connection

disconnect

protected void disconnect(java.lang.Throwable error)

request a disconnect

Parameters:

error - optionally the error that caused the request to close

getConnectionInformation

public ConnectionInformation getConnectionInformation()

Specified by:

getConnectionInformation in interface Connection

addConnectionStateListener

public void addConnectionStateListener(ConnectionStateListener connectionStateListener)

Specified by:

addConnectionStateListener in interface Connection

removeConnectionStateListener

public void removeConnectionStateListener(ConnectionStateListener connectionStateListener)

Specified by:

removeConnectionStateListener in interface Connection

getState

public ConnectionState getState()

Description copied from interface: Connection

Get the current connection state

Specified by:

getState in interface Connection

Returns:

The current connection state

setupConnector

protected void setupConnector(ConnectionInformation connectionInformation,
                  IoConnector connector)

isConnected

public boolean isConnected()

connect

public void connect(CallbackHandler callbackHandler)

Description copied from interface: Connection

Start the connection with a callback handler

Specified by:

connect in interface Connection

connect

public void connect()

Description copied from interface: Connection

Start the connection

Specified by:

connect in interface Connection

performLookup

protected void performLookup()

resolvedRemoteAddress

protected void resolvedRemoteAddress(java.net.SocketAddress address,
                         java.lang.Throwable e)

performConnect

protected void performConnect()

connectFailed

protected void connectFailed(ConnectFuture future,
                 java.lang.Throwable e)

called when a connection attempt failed

Parameters:

future -

e - the error

cancelConnection

public void cancelConnection()

Cancel an open connection ... for debug purposes only

onConnectionClosed

protected void onConnectionClosed()

onConnectionEstablished

protected void onConnectionEstablished()

setBound

public void setBound(java.util.Properties properties)

Set the ConnectionState.BOUND including the session properties

Parameters:

properties -

onConnectionBound

protected void onConnectionBound()

exceptionCaught

public void exceptionCaught(IoSession session,
                   java.lang.Throwable cause)
                     throws java.lang.Exception

Throws:

java.lang.Exception

messageReceived

public void messageReceived(IoSession session,
                   java.lang.Object message)
                     throws java.lang.Exception

Throws:

java.lang.Exception

messageSent

public void messageSent(IoSession session,
               java.lang.Object message)
                 throws java.lang.Exception

Throws:

java.lang.Exception

sessionClosed

public void sessionClosed(IoSession session)
                   throws java.lang.Exception

Throws:

java.lang.Exception

sessionCreated

public void sessionCreated(IoSession session)
                    throws java.lang.Exception

Throws:

java.lang.Exception

sessionIdle

public void sessionIdle(IoSession session,
               IdleStatus status)
                 throws java.lang.Exception

Throws:

java.lang.Exception

sessionOpened

public void sessionOpened(IoSession session)
                   throws java.lang.Exception

Throws:

java.lang.Exception

getConnectTimeout

public int getConnectTimeout()

get the timeout used for connecting to the remote host

Returns:

the timeout in milliseconds

getPingPeriod

public int getPingPeriod()

getSocketReceiveBufferSize

public java.lang.Integer getSocketReceiveBufferSize()

getSocketSendBufferSize

public java.lang.Integer getSocketSendBufferSize()

getMessageTimeout

public int getMessageTimeout()

getIntProperty

protected java.lang.Integer getIntProperty(java.lang.String propertyName,
                               java.lang.Integer defaultValue)

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

dispose

public void dispose()

Description copied from interface: Connection

Dispose the connection

A dispose will also act as a disconnect.

Connections must be disposed in order to clean up all resources. In the past the Connection.disconnect() call was enough and, if possible, most resources (sockets) should be closed when disconnecting. Still some resources can be re-used and these need to be cleaned up in the Connection.dispose() call.

Specified by:

dispose in interface Connection

getSessionProperties

public java.util.Map<java.lang.String,java.lang.String> getSessionProperties()

Description copied from interface: Connection

Return the session properties as provided by the server. The session properties are only valid if the connection is in the state ConnectionState.BOUND

Specified by:

getSessionProperties in interface Connection

Returns:

the connection properties

getStatistics

public java.util.Collection<StatisticEntry> getStatistics()