Package org.jcsp.lang

Class BlackHoleChannel

  • All Implemented Interfaces:
    ChannelOutput, Poisonable

    public class BlackHoleChannel
    extends java.lang.Object
    implements ChannelOutput
    This implements ChannelOutput with black hole semantics.

    Description

    BlackHoleChannel is an implementation of ChannelOutput that yields black hole semantics for the channel. Writers may always write but there can be no readers. Any number of writers may share the same black hole.

    Note: BlackHoleChannels are used for masking off unwanted outputs from processes. They are useful when we want to reuse an existing process component intact, but don't need some of its output channels (i.e. we don't want to redesign and reimplement the component to remove the redundant channels). Normal channels cannot be plugged in and left dangling as this may deadlock (parts of) the component being reused.

    See Also:
    ChannelOutput, One2OneChannel, Any2OneChannel, One2AnyChannel, Any2AnyChannel
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void poison​(int strength)
      This injects poison into the channel.
      void write​(java.lang.Object object)
      Write an Object to the channel and lose it.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • BlackHoleChannel

        public BlackHoleChannel()
    • Method Detail

      • write

        public void write​(java.lang.Object object)
        Write an Object to the channel and lose it.
        Specified by:
        write in interface ChannelOutput
        Parameters:
        object - the object to write to the channel.
      • poison

        public void poison​(int strength)
        Description copied from interface: Poisonable
        This injects poison into the channel. If the channel was not explicitly constructed to be poisonable or if the strength of poison is not greater than the channel immunity level, the poison will have no effect.
        Specified by:
        poison in interface Poisonable
        Parameters:
        strength - the strength of the poison (must be >= 0).