com.barchart.udt.nio.ChannelUDT Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of barchart-udt-core Show documentation

Barchart UDT [ CORE ]

The newest version!

/**
 * Copyright (C) 2009-2013 Barchart, Inc. 
 *
 * All rights reserved. Licensed under the OSI BSD License.
 *
 * http://www.opensource.org/licenses/bsd-license.php
 */
package com.barchart.udt.nio;

import java.nio.channels.Channel;
import java.nio.channels.SelectionKey;

import com.barchart.udt.SocketUDT;
import com.barchart.udt.TypeUDT;

/**
 * Interface shared by all {@link KindUDT} kinds.
 */
public interface ChannelUDT extends Channel {

	/**
	 * Was connection request
	 * {@link SocketChannelUDT#connect(java.net.SocketAddress)} acknowledged by
	 * {@link SocketChannelUDT#finishConnect()}?
	 */
	boolean isConnectFinished();

	/**
	 * The kind of UDT channel.
	 */
	KindUDT kindUDT();

	/**
	 * UDT specific provider which produced this channel.
	 */
	SelectorProviderUDT providerUDT();

	/**
	 * Underlying UDT socket.
	 */
	SocketUDT socketUDT();

	/**
	 * The type of UDT socket.
	 */
	TypeUDT typeUDT();

	/**
	 * Mask of all interest options which are permitted for this channel.
	 * 
	 * @see SelectionKey
	 */
	int validOps();

}