edu.utah.janos.nodeos
Class InChannelHandle

java.lang.Object
  |
  +--edu.utah.janos.nodeos.pj_InChannelHandle
        |
        +--edu.utah.janos.nodeos.InChannelHandle

public final class InChannelHandle

extends edu.utah.janos.nodeos.pj_InChannelHandle

A cross-process handle on a Java NodeOS InChannel.

Packets can be inserted into an InChannel via an InChannelHandle.

Author:

Janos Ministry of Development

See Also:

InChannel

Constructor Summary

InChannelHandle()
Construct a handle that doesn't refer to anything.

InChannelHandle(InChannel inChan)

Method Summary

void	copy(InChannelHandle otherChan)
boolean	handoff(BufferHandle pkt) Push a buffer onto the associated InChannel.
boolean	handoffv(BufferHandle[] bhl)
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

InChannelHandle

public InChannelHandle()

Construct a handle that doesn't refer to anything.

InChannelHandle

public InChannelHandle(InChannel inChan)

Parameters:

inChan - The InChannel object that this handle should refer too.

Method Detail

copy

public void copy(InChannelHandle otherChan)

Parameters:

otherChan - The InChannelHandle to copy.

handoff

public boolean handoff(BufferHandle pkt)

Push a buffer onto the associated InChannel. The given packet data is either copied into or swapped with packet data on the InChannel.

Returns true if the packet was swapped/copied. False if the not (the channel is dead, there was no buffer space, etc).

handoffv

public boolean handoffv(BufferHandle[] bhl)

toString

public java.lang.String toString()

Overrides:

toString in class edu.utah.janos.nodeos.pj_InChannelHandle