Class MigratableChannelOutputImpl

java.lang.Object

org.jcsp.net.dynamic.MigratableChannelOutputImpl

All Implemented Interfaces:

Serializable, ChannelOutput, Poisonable, MigratableChannelOutput, NetChannelOutput, Networked, FilteredChannelOutput, WriteFiltered

class MigratableChannelOutputImpl
extends Object
implements MigratableChannelOutput

Implements of a migratable networked channel output end.

Field Summary

Fields

Modifier and Type	Field	Description
private NetChannelOutput	actualOut	The actual networked output channel end.
private FilteredChannelOutput	filteredOut	The filtered channel end.
private Vector	filters	The filters applied to the channel.
private OutputReconnectionManager	mgr	The output reconnection manager for the channel.

Constructor Summary

Constructors

Constructor	Description
MigratableChannelOutputImpl(OutputReconnectionManager mgr)	Constructs a new MigratableChannelOutputImpl with the given reconnection manager.
MigratableChannelOutputImpl(NetChannelOutput out)	MigratableChannelOutputImpl objects constructed with this constructor make use of the default channel name service.

Method Summary

Modifier and Type	Method	Description
void	addWriteFilter(Filter filter)	Installs a write filter defining a transformation to be applied by the write method of the channel end.
void	addWriteFilter(Filter filter, int index)	Installs a write filter defining a transformation to be applied by the write method of the channel end at a specific index.
void	destroyWriter()	Destroys the channel writer end and frees all the underlying JCSP.NET resources.
NetChannelLocation	getChannelLocation()	Returns the location of the Networked ChannelInput.
Class	getFactoryClass()	Returns the factory class used for constructing this channel end object.
Filter	getWriteFilter(int index)	Returns the write filter installed at the given index.
int	getWriteFilterCount()	Returns the number of write filters currently installed.
void	poison(int strength)	Currently, network channels are unpoisonable so this method has no effect.
void	prepareToMove()	Prepares the channel end for movement to another node.
void	recreate()	Requests that the instance of the implementing class should reinitialize itself.
void	recreate(NetChannelLocation newLoc)	Requests that the instance of the implementing class should reinitialize itself with a new location.
void	removeWriteFilter(int index)	Removes the write filter installed at the given index.
void	removeWriteFilter(Filter filter)	Removes the first write filter (lowest index) matching the filter given as a parameter.
void	write(Object object)	Write an Object to the channel.
private void	writeObject(ObjectOutputStream out)

Methods inherited from class Object

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

Field Details

mgr

private OutputReconnectionManager mgr

The output reconnection manager for the channel.

actualOut

private transient NetChannelOutput actualOut

The actual networked output channel end.

filteredOut

private transient FilteredChannelOutput filteredOut

The filtered channel end.

filters

private Vector filters

The filters applied to the channel.

Constructor Details

MigratableChannelOutputImpl

public MigratableChannelOutputImpl(NetChannelOutput out)

MigratableChannelOutputImpl objects constructed with this constructor make use of the default channel name service.

Parameters:

out - the underlying networked channel output.

MigratableChannelOutputImpl

public MigratableChannelOutputImpl(OutputReconnectionManager mgr)

Constructs a new MigratableChannelOutputImpl with the given reconnection manager.

Parameters:

mgr - the reconnection manager to use for the channel.

Method Details

prepareToMove

public void prepareToMove()

Description copied from interface: MigratableChannelOutput

Prepares the channel end for movement to another node.

Specified by:

prepareToMove in interface MigratableChannelOutput

See Also:

• MigratableChannelOutput.prepareToMove()

recreate

public void recreate()

Description copied from interface: NetChannelOutput

Requests that the instance of the implementing class should reinitialize itself.

Specified by:

recreate in interface NetChannelOutput

See Also:

• NetChannelOutput.recreate()

recreate

public void recreate(NetChannelLocation newLoc)

Description copied from interface: NetChannelOutput

Requests that the instance of the implementing class should reinitialize itself with a new location.

Specified by:

recreate in interface NetChannelOutput

Parameters:

newLoc - the new location.

See Also:

• NetChannelOutput.recreate(NetChannelLocation)

destroyWriter

public void destroyWriter()

Description copied from interface: NetChannelOutput

Destroys the channel writer end and frees all the underlying JCSP.NET resources.

Specified by:

destroyWriter in interface NetChannelOutput

See Also:

• NetChannelOutput.destroyWriter()

write

public void write(Object object)

Description copied from interface: ChannelOutput

Write an Object to the channel.

Specified by:

write in interface ChannelOutput

Parameters:

object - the object to write to the channel

See Also:

• ChannelOutput.write(Object)

getChannelLocation

public NetChannelLocation getChannelLocation()

Description copied from interface: Networked

Returns the location of the Networked ChannelInput.

Specified by:

getChannelLocation in interface Networked

Returns:

the NetChannelLocation object.

See Also:

• Networked.getChannelLocation()

getFactoryClass

public Class getFactoryClass()

Description copied from interface: NetChannelOutput

Returns the factory class used for constructing this channel end object.

Specified by:

getFactoryClass in interface NetChannelOutput

Returns:

the Class of the

addWriteFilter

public void addWriteFilter(Filter filter)

Description copied from interface: WriteFiltered

Installs a write filter defining a transformation to be applied by the write method of the channel end. The filter will be appended to the end of the current list, making it the last to be applied.

Specified by:

addWriteFilter in interface WriteFiltered

Parameters:

filter - the filter to be installed; may not be null.

See Also:

• WriteFiltered.addWriteFilter(Filter)

addWriteFilter

public void addWriteFilter(Filter filter,
 int index)

Description copied from interface: WriteFiltered

Installs a write filter defining a transformation to be applied by the write method of the channel end at a specific index. If there is already a filter at that index position the existing filters are shifted to make room. If the index is greater than the number of filters already installed the filter is placed at the end.

Specified by:

addWriteFilter in interface WriteFiltered

Parameters:

filter - the filter to be installed; may not be null.

index - the zero based index; may not be negative.

See Also:

• WriteFiltered.addWriteFilter(Filter, int)

removeWriteFilter

public void removeWriteFilter(Filter filter)

Description copied from interface: WriteFiltered

Removes the first write filter (lowest index) matching the filter given as a parameter. The filter removed, r, will satisfy the condition r.equals (filter). The remaining filters are shifted to close the gap in the index allocation.

Specified by:

removeWriteFilter in interface WriteFiltered

Parameters:

filter - the filter to be removed; may not be null.

See Also:

• WriteFiltered.removeWriteFilter(Filter)

removeWriteFilter

public void removeWriteFilter(int index)

Description copied from interface: WriteFiltered

Removes the write filter installed at the given index. The remaining filters are shifted to close the gap in the index allocation.

Specified by:

removeWriteFilter in interface WriteFiltered

Parameters:

index - zero-based index of the filter to be removed.

See Also:

• WriteFiltered.removeWriteFilter(int)

getWriteFilter

public Filter getWriteFilter(int index)

Description copied from interface: WriteFiltered

Returns the write filter installed at the given index.

Specified by:

getWriteFilter in interface WriteFiltered

Parameters:

index - zero-based index of the filter to return.

Returns:

the filter at that position.

See Also:

• WriteFiltered.getWriteFilter(int)

getWriteFilterCount

public int getWriteFilterCount()

Description copied from interface: WriteFiltered

Returns the number of write filters currently installed.

Specified by:

getWriteFilterCount in interface WriteFiltered

See Also:

• WriteFiltered.getWriteFilterCount()

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

poison

public void poison(int strength)

Currently, network channels are unpoisonable so this method has no effect.

Specified by:

poison in interface Poisonable

Parameters:

strength - the strength of the poison (must be >= 0).