org.eclipse.net4j.util.event.Notifier

org.eclipse.net4j.util.lifecycle.Lifecycle

org.eclipse.spi.net4j.Channel

All Implemented Interfaces:: IBufferHandler, IBufferProvider, IChannel, ILocationAware, org.eclipse.net4j.util.collection.Closeable, org.eclipse.net4j.util.concurrent.IExecutorServiceProvider, org.eclipse.net4j.util.container.IManagedContainerProvider, org.eclipse.net4j.util.event.INotifier, org.eclipse.net4j.util.event.INotifier.INotifier2, org.eclipse.net4j.util.lifecycle.IDeactivateable, org.eclipse.net4j.util.lifecycle.ILifecycle, org.eclipse.net4j.util.lifecycle.ILifecycle.DeferrableActivation, org.eclipse.net4j.util.security.IUserAware, InternalChannel

public class Channel extends org.eclipse.net4j.util.lifecycle.Lifecycle implements InternalChannel, org.eclipse.net4j.util.concurrent.IExecutorServiceProvider, org.eclipse.net4j.util.container.IManagedContainerProvider

If the meaning of this type isn't clear, there really should be more of a description here...

Since:: 2.0
Author:: Eike Stepper

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

protected class

Channel.ReceiverWork

Deprecated.
As of 4.10 scheduled for future removal.

protected class

Channel.ReceiveSerializer

Deprecated.
As of 4.4 scheduled for future removal.

protected class

Channel.SendQueue

A queue that holds buffers that shall be sent.

Nested classes/interfaces inherited from interface org.eclipse.net4j.buffer.IBufferProvider
IBufferProvider.Introspection, IBufferProvider.Notification

Nested classes/interfaces inherited from interface org.eclipse.net4j.util.lifecycle.ILifecycle
org.eclipse.net4j.util.lifecycle.ILifecycle.DeferrableActivation

Nested classes/interfaces inherited from interface org.eclipse.net4j.ILocationAware
ILocationAware.Location

Nested classes/interfaces inherited from interface org.eclipse.net4j.util.event.INotifier
org.eclipse.net4j.util.event.INotifier.INotifier2

Nested classes/interfaces inherited from interface org.eclipse.spi.net4j.InternalChannel
InternalChannel.CountersChangedEvent, InternalChannel.SendQueueEvent
Field Summary

Fields inherited from class org.eclipse.net4j.util.lifecycle.Lifecycle
USE_LABEL
Constructor Summary

Constructors

Constructor

Description

Channel()
Method Summary

Modifier and Type

Method

Description

void

close()

protected Channel.ReceiverWork

createReceiverWork(IBuffer buffer)

Deprecated.
As of 4.10 scheduled for future removal.

protected void

doActivate()

protected void

doBeforeActivate()

protected void

doDeactivate()

short

getBufferCapacity()

Returns the capacity of the buffers provided by IBufferProvider.provideBuffer() .

org.eclipse.net4j.util.container.IManagedContainer

getContainer()

ExecutorService

getExecutorService()

short

getID()

Returns the ID of this channel.

ILocationAware.Location

getLocation()

Returns the location of this object in a client/server scenario.

IChannelMultiplexer

getMultiplexer()

Returns the multiplexer this channel is associated with.

long

getReceivedBuffers()

Returns the number of buffers that are received from the multiplexer of this channel and are passed on to the receive handler of this channel.

final long

getReceivedBytes()

Returns the number of bytes that are received from the multiplexer of this channel and are passed on to the receive handler of this channel.

ExecutorService

getReceiveExecutor()

Deprecated.

IBufferHandler

getReceiveHandler()

Returns the IBufferHandler that handles buffers received from the peer channel.

Queue<IBuffer>

getSendQueue()

long

getSentBuffers()

Returns the number of buffers that are sent to the multiplexer of this channel.

final long

getSentBytes()

Returns the number of bytes that are sent to the multiplexer of this channel.

String

getUserID()

void

handleBuffer(IBuffer buffer)

Handles the given buffer.

void

handleBufferFromMultiplexer(IBuffer buffer)

Handles a buffer sent by the multiplexer.

boolean

isClient()

Same as ILocationAware.getLocation() == ILocationAware.Location.CLIENT.

boolean

isClosed()

boolean

isServer()

Same as ILocationAware.getLocation() == ILocationAware.Location.SERVER.

IBuffer

provideBuffer()

Provides a buffer from this BufferProvider.

void

retainBuffer(IBuffer buffer)

Retains a buffer to this BufferProvider.

void

sendBuffer(IBuffer buffer)

Asynchronously sends the given buffer to the receive handler of the peer channel.

void

setID(short id)

void

setMultiplexer(IChannelMultiplexer channelMultiplexer)

void

setReceiveExecutor(ExecutorService receiveExecutor)

Deprecated.

void

setReceiveHandler(IBufferHandler receiveHandler)

Sets the IBufferHandler to handle buffers received from the peer channel.

void

setUserID(String userID)

String

toString()

protected void

unregisterFromMultiplexer()

Methods inherited from class org.eclipse.net4j.util.lifecycle.Lifecycle
activate, checkActive, checkArg, checkArg, checkInactive, checkNull, checkState, checkState, deactivate, deferredActivate, doAfterActivate, doBeforeDeactivate, dump, getLifecycleState, isActive, isDeferredActivation

Methods inherited from class org.eclipse.net4j.util.event.Notifier
addListener, addUniqueListener, fireEvent, fireEvent, fireEvent, fireThrowable, firstListenerAdded, getListeners, getNotificationService, hasListener, hasListeners, lastListenerRemoved, listenerAdded, listenerRemoved, removeListener

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.net4j.util.lifecycle.ILifecycle
activate, deactivate, getLifecycleState, isActive

Methods inherited from interface org.eclipse.net4j.util.event.INotifier
addListener, getListeners, hasListeners, removeListener

Constructor Details
- Channel
  
  public Channel()
Method Details
- getContainer
  
  public org.eclipse.net4j.util.container.IManagedContainer getContainer()
  
  Specified by:
  
  getContainer in interface org.eclipse.net4j.util.container.IManagedContainerProvider
- getUserID
  
  public String getUserID()
  
  Specified by:
  
  getUserID in interface org.eclipse.net4j.util.security.IUserAware
- setUserID
  
  public void setUserID(String userID)
  
  Specified by:
  
  setUserID in interface InternalChannel
- getLocation
  
  public ILocationAware.Location getLocation()
  
  Description copied from interface: ILocationAware
  
  Returns the location of this object in a client/server scenario.
  
  Specified by:
  
  getLocation in interface ILocationAware
- isClient
  
  public boolean isClient()
  
  Description copied from interface: ILocationAware
  
  Same as ILocationAware.getLocation() == ILocationAware.Location.CLIENT.
  
  Specified by:
  
  isClient in interface ILocationAware
- isServer
  
  public boolean isServer()
  
  Description copied from interface: ILocationAware
  
  Same as ILocationAware.getLocation() == ILocationAware.Location.SERVER.
  
  Specified by:
  
  isServer in interface ILocationAware
- getMultiplexer
  
  public IChannelMultiplexer getMultiplexer()
  
  Description copied from interface: IChannel
  
  Returns the multiplexer this channel is associated with. This channel multiplexer can be used, for example, to open additional channels that will be multiplexed through the same transport medium.
  
  Specified by:
  
  getMultiplexer in interface IChannel
- setMultiplexer
  
  public void setMultiplexer(IChannelMultiplexer channelMultiplexer)
  
  Specified by:
  
  setMultiplexer in interface InternalChannel
- getID
  
  public short getID()
  
  Description copied from interface: IChannel
  
  Returns the ID of this channel. The ID is unique at any time among all channels of the associated multiplexer.
  
  Specified by:
  
  getID in interface IChannel
- setID
  
  public void setID(short id)
  
  Specified by:
  
  setID in interface InternalChannel
- getExecutorService
  
  public ExecutorService getExecutorService()
  
  Specified by:
  
  getExecutorService in interface org.eclipse.net4j.util.concurrent.IExecutorServiceProvider
  
  Since:
  
  4.5
- getReceiveExecutor
  
  @Deprecated public ExecutorService getReceiveExecutor()
  
  Deprecated.
  
  Specified by:
  
  getReceiveExecutor in interface InternalChannel
- setReceiveExecutor
  
  @Deprecated public void setReceiveExecutor(ExecutorService receiveExecutor)
  
  Deprecated.
  
  Specified by:
  
  setReceiveExecutor in interface InternalChannel
- getReceiveHandler
  
  public IBufferHandler getReceiveHandler()
  
  Description copied from interface: IChannel
  
  Returns the IBufferHandler that handles buffers received from the peer channel.
  
  Specified by:
  
  getReceiveHandler in interface IChannel
- setReceiveHandler
  
  public void setReceiveHandler(IBufferHandler receiveHandler)
  
  Description copied from interface: IChannel
  
  Sets the IBufferHandler to handle buffers received from the peer channel.
  
  Specified by:
  
  setReceiveHandler in interface IChannel
- getSentBuffers
  
  public long getSentBuffers()
  
  Description copied from interface: IChannel
  
  Returns the number of buffers that are sent to the multiplexer of this channel.
  
  Specified by:
  
  getSentBuffers in interface IChannel
  
  Since:
  
  3.0
- getSentBytes
  
  public final long getSentBytes()
  
  Description copied from interface: IChannel
  
  Returns the number of bytes that are sent to the multiplexer of this channel.
  
  Specified by:
  
  getSentBytes in interface IChannel
  
  Since:
  
  4.13
- getReceivedBuffers
  
  public long getReceivedBuffers()
  
  Description copied from interface: IChannel
  
  Returns the number of buffers that are received from the multiplexer of this channel and are passed on to the receive handler of this channel.
  
  Specified by:
  
  getReceivedBuffers in interface IChannel
  
  Since:
  
  3.0
- getReceivedBytes
  
  public final long getReceivedBytes()
  
  Description copied from interface: IChannel
  
  Returns the number of bytes that are received from the multiplexer of this channel and are passed on to the receive handler of this channel.
  
  Specified by:
  
  getReceivedBytes in interface IChannel
  
  Since:
  
  4.13
- getSendQueue
  
  public Queue<IBuffer> getSendQueue()
  
  Specified by:
  
  getSendQueue in interface InternalChannel
- sendBuffer
  
  public void sendBuffer(IBuffer buffer)
  
  Description copied from interface: IChannel
  
  Asynchronously sends the given buffer to the receive handler of the peer channel.
  
  Specified by:
  
  sendBuffer in interface IChannel
- handleBuffer
  
  public void handleBuffer(IBuffer buffer)
  
  Handles the given buffer. Ensures it is in the PUTTING state (otherwise ignores it) and sends it on behalf of the send queue.
  Specified by:
  
  handleBuffer in interface IBufferHandler
  
  Parameters:
  
  buffer - The buffer to be handled.
  
  See Also:
  
  IBuffer.getState()
  
  BufferState.PUTTING
  
  sendQueue
- handleBufferFromMultiplexer
  
  public void handleBufferFromMultiplexer(IBuffer buffer)
  
  Handles a buffer sent by the multiplexer. Adds work to the receive queue or releases the buffer.
  Specified by:
  
  handleBufferFromMultiplexer in interface InternalChannel
  
  See Also:
  
  InternalChannelMultiplexer.multiplexChannel(org.eclipse.spi.net4j.InternalChannel)
- createReceiverWork
  
  @Deprecated protected Channel.ReceiverWork createReceiverWork(IBuffer buffer)
  
  Deprecated.
  As of 4.10 scheduled for future removal.
- getBufferCapacity
  
  public short getBufferCapacity()
  
  Description copied from interface: IBufferProvider
  
  Returns the capacity of the buffers provided by IBufferProvider.provideBuffer() .
  
  Specified by:
  
  getBufferCapacity in interface IBufferProvider
- provideBuffer
  
  public IBuffer provideBuffer()
  
  Description copied from interface: IBufferProvider
  
  Provides a buffer from this BufferProvider.
  
  Specified by:
  
  provideBuffer in interface IBufferProvider
- retainBuffer
  
  public void retainBuffer(IBuffer buffer)
  
  Description copied from interface: IBufferProvider
  
  Retains a buffer to this BufferProvider.
  
  Specified by:
  
  retainBuffer in interface IBufferProvider
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class org.eclipse.net4j.util.lifecycle.Lifecycle
- doBeforeActivate
  
  protected void doBeforeActivate() throws Exception
  
  Overrides:
  
  doBeforeActivate in class org.eclipse.net4j.util.lifecycle.Lifecycle
  
  Throws:
  
  Exception
- doActivate
  
  protected void doActivate() throws Exception
  
  Overrides:
  
  doActivate in class org.eclipse.net4j.util.lifecycle.Lifecycle
  
  Throws:
  
  Exception
- doDeactivate
  
  protected void doDeactivate() throws Exception
  
  Overrides:
  
  doDeactivate in class org.eclipse.net4j.util.lifecycle.Lifecycle
  
  Throws:
  
  Exception
- unregisterFromMultiplexer
  
  protected void unregisterFromMultiplexer()
- close
  
  public void close()
  
  Specified by:
  
  close in interface org.eclipse.net4j.util.collection.Closeable
- isClosed
  
  public boolean isClosed()
  
  Specified by:
  
  isClosed in interface org.eclipse.net4j.util.collection.Closeable

Class Channel

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.net4j.buffer.IBufferProvider

Nested classes/interfaces inherited from interface org.eclipse.net4j.util.lifecycle.ILifecycle

Nested classes/interfaces inherited from interface org.eclipse.net4j.ILocationAware

Nested classes/interfaces inherited from interface org.eclipse.net4j.util.event.INotifier

Nested classes/interfaces inherited from interface org.eclipse.spi.net4j.InternalChannel

Field Summary

Fields inherited from class org.eclipse.net4j.util.lifecycle.Lifecycle

Constructor Summary

Method Summary

Methods inherited from class org.eclipse.net4j.util.lifecycle.Lifecycle

Methods inherited from class org.eclipse.net4j.util.event.Notifier

Methods inherited from class java.lang.Object

Methods inherited from interface org.eclipse.net4j.util.lifecycle.ILifecycle

Methods inherited from interface org.eclipse.net4j.util.event.INotifier

Constructor Details

Channel

Method Details

getContainer

getUserID

setUserID

getLocation

isClient

isServer

getMultiplexer

setMultiplexer

getID

setID

getExecutorService

getReceiveExecutor

setReceiveExecutor

getReceiveHandler

setReceiveHandler

getSentBuffers

getSentBytes

getReceivedBuffers

getReceivedBytes

getSendQueue

sendBuffer

handleBuffer

handleBufferFromMultiplexer

createReceiverWork

getBufferCapacity

provideBuffer

retainBuffer

toString

doBeforeActivate

doActivate

doDeactivate

unregisterFromMultiplexer

close

isClosed