de.mklinger.qetcher.client.jetty.io.Connection Maven / Gradle / Ivy
Show all versions of qetcher-client-bundle Show documentation
//
// ========================================================================
// Copyright (c) 1995-2018 Mort Bay Consulting Pty. Ltd.
// ------------------------------------------------------------------------
// All rights reserved. This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v1.0
// and Apache License v2.0 which accompanies this distribution.
//
// The Eclipse Public License is available at
// http://www.eclipse.org/legal/epl-v10.html
//
// The Apache License v2.0 is available at
// http://www.opensource.org/licenses/apache2.0.php
//
// You may elect to redistribute this code under either of these licenses.
// ========================================================================
//
package org.eclipse.jetty.io;
import java.io.Closeable;
import java.nio.ByteBuffer;
import org.eclipse.jetty.util.component.Container;
/**
* A {@link Connection} is associated to an {@link EndPoint} so that I/O events
* happening on the {@link EndPoint} can be processed by the {@link Connection}.
* A typical implementation of {@link Connection} overrides {@link #onOpen()} to
* {@link EndPoint#fillInterested(org.eclipse.jetty.util.Callback) set read interest} on the {@link EndPoint},
* and when the {@link EndPoint} signals read readyness, this {@link Connection} can
* read bytes from the network and interpret them.
*/
public interface Connection extends Closeable
{
/**
* Adds a listener of connection events.
*
* @param listener the listener to add
*/
public void addListener(Listener listener);
/**
* Removes a listener of connection events.
*
* @param listener the listener to remove
*/
public void removeListener(Listener listener);
/**
* Callback method invoked when this connection is opened.
* Creators of the connection implementation are responsible for calling this method.
*/
public void onOpen();
/**
* Callback method invoked when this connection is closed.
* Creators of the connection implementation are responsible for calling this method.
*/
public void onClose();
/**
* @return the {@link EndPoint} associated with this Connection.
*/
public EndPoint getEndPoint();
/**
* Performs a logical close of this connection.
* For simple connections, this may just mean to delegate the close to the associated
* {@link EndPoint} but, for example, SSL connections should write the SSL close message
* before closing the associated {@link EndPoint}.
*/
@Override
public void close();
/**
* Callback method invoked upon an idle timeout event.
* Implementations of this method may return true to indicate that the idle timeout
* handling should proceed normally, typically failing the EndPoint and causing it to
* be closed.
* When false is returned, the handling of the idle timeout event is halted
* immediately and the EndPoint left in the state it was before the idle timeout event.
*
* @return true to let the EndPoint handle the idle timeout,
* false to tell the EndPoint to halt the handling of the idle timeout.
*/
public boolean onIdleExpired();
public long getMessagesIn();
public long getMessagesOut();
public long getBytesIn();
public long getBytesOut();
public long getCreatedTimeStamp();
public interface UpgradeFrom
{
/**
* Takes the input buffer from the connection on upgrade.
* This method is used to take any unconsumed input from
* a connection during an upgrade.
*
* @return A buffer of unconsumed input. The caller must return the buffer
* to the bufferpool when consumed and this connection must not.
*/
ByteBuffer onUpgradeFrom();
}
public interface UpgradeTo
{
/**
* Callback method invoked when this connection is upgraded.
* This must be called before {@link #onOpen()}.
* @param prefilled An optional buffer that can contain prefilled data. Typically this
* results from an upgrade of one protocol to the other where the old connection has buffered
* data destined for the new connection. The new connection must take ownership of the buffer
* and is responsible for returning it to the buffer pool
*/
void onUpgradeTo(ByteBuffer prefilled);
}
/**
* A Listener for connection events.
* Listeners can be added to a {@link Connection} to get open and close events.
* The AbstractConnectionFactory implements a pattern where objects implement
* this interface that have been added via {@link Container#addBean(Object)} to
* the Connector or ConnectionFactory are added as listeners to all new connections
*
*/
public interface Listener
{
public void onOpened(Connection connection);
public void onClosed(Connection connection);
public static class Adapter implements Listener
{
@Override
public void onOpened(Connection connection)
{
}
@Override
public void onClosed(Connection connection)
{
}
}
}
}