Package org.jcsp.net2

Interface NetChannelEndFactory

  • All Known Implementing Classes:
    StandardNetChannelEndFactory

    public interface NetChannelEndFactory
    This interface defines the methods that any networked channel factory must implement. For a concrete implementation, see StandardNetChannelEndFactory
    Author:
    Kevin Chalmers (updated from Quickstone Technologies)
    See Also:
    StandardNetChannelEndFactory
    • Method Detail

      • net2one

        <T> NetAltingChannelInput<T> net2one()
        Creates a new NetAltingChannelInput
        Returns:
        A new NetAltingChannelInput
      • net2one

        <T> NetAltingChannelInput<T> net2one​(int immunityLevel)
        Creates a new NetAltingChannelInput with the given immunity level for poison
        Parameters:
        immunityLevel - The immunity level for poison
        Returns:
        A new NetAltingChannelInput
      • net2one

        <T> NetAltingChannelInput<T> net2one​(NetworkMessageFilter.FilterRx filter)
        Creates a new NetAltingChannelInput which uses the given filter to decode incoming messages
        Parameters:
        filter - The filter used to decode incoming messages
        Returns:
        A new NetAltingChannelInput
      • net2one

        <T> NetAltingChannelInput<T> net2one​(int immunityLevel,
                                             NetworkMessageFilter.FilterRx filter)
        Creates a new NetAltingChannelInput with the given poison immunity level which uses the given filter to decode incoming messages
        Parameters:
        immunityLevel - The immunity level to poison for the created channel
        filter - The filter used to decode incoming messages
        Returns:
        A new NetAltingChannelInput
      • net2any

        <T> NetSharedChannelInput<T> net2any()
        Creates a new NetSharedChannelInput
        Returns:
        A new NetSharedChannelInput
      • net2any

        <T> NetSharedChannelInput<T> net2any​(int immunityLevel)
        Creates a new NetSharedChannelInput with the given poison immunity level
        Parameters:
        immunityLevel - The immunity level to poison for this channel
        Returns:
        A new NetSharedChannelInput
      • net2any

        <T> NetSharedChannelInput<T> net2any​(NetworkMessageFilter.FilterRx filter)
        Creates a new NetSharedChannelInput which uses the given filter to decode incoming messages
        Parameters:
        filter - The filter used to decode incoming messages
        Returns:
        A new NetSharedChannelInput
      • net2any

        <T> NetSharedChannelInput<T> net2any​(int immunityLevel,
                                             NetworkMessageFilter.FilterRx filter)
        Creates a new NetSharedChannelInput with the given poison immunity level, which uses the given filter to decode messages
        Parameters:
        immunityLevel - The immunity level to poison for this channel
        filter - The filter used to decode incoming messages
        Returns:
        A new NetSharedChannelInput
      • numberedNet2One

        <T> NetAltingChannelInput<T> numberedNet2One​(int index)
                                              throws IllegalArgumentException
        Creates a new NetAltingChannelInput with the given index
        Parameters:
        index - The index to create the channel with
        Returns:
        A new NetAltingChannelInput
        Throws:
        IllegalArgumentException - Thrown if a channel with the given index already exists
      • numberedNet2One

        <T> NetAltingChannelInput<T> numberedNet2One​(int index,
                                                     int immunityLevel)
                                              throws IllegalArgumentException
        Creates a new NetAltingChannelInput with the given index and the given poison immunity level
        Parameters:
        index - The index to create the channel with
        immunityLevel - The immunity to poison that the channel has
        Returns:
        A new NetAltingChannelInput
        Throws:
        IllegalArgumentException - Thrown if a channel with the given index already exists
      • numberedNet2One

        <T> NetAltingChannelInput<T> numberedNet2One​(int index,
                                                     NetworkMessageFilter.FilterRx filter)
                                              throws IllegalArgumentException
        Creates a new NetAltingChannelInput with the given index that uses the given filter to decode incoming messages
        Parameters:
        index - The index to create the channel with
        filter - The filter used to decode incoming messages
        Returns:
        A new NetAltingChannelInput
        Throws:
        IllegalArgumentException - Thrown if a channel with the given index already exists
      • numberedNet2One

        <T> NetAltingChannelInput<T> numberedNet2One​(int index,
                                                     int immunityLevel,
                                                     NetworkMessageFilter.FilterRx filter)
                                              throws IllegalArgumentException
        Creates a new NetAltingChannelInput with the given index and given poison immunity, which uses the given filter to decode incoming messages
        Parameters:
        index - The index to create the channel with
        immunityLevel - The immunity to poison that the channel has
        filter - The filter used to decode incoming messages
        Returns:
        A new NetAltingChannelInput
        Throws:
        IllegalArgumentException - Thrown if a channel with the given index already exists
      • numberedNet2Any

        <T> NetSharedChannelInput<T> numberedNet2Any​(int index)
                                              throws IllegalArgumentException
        Creates a new NetSharedChannelInput with the given index
        Parameters:
        index - The index to create the channel with
        Returns:
        A new NetSharedChannelInput
        Throws:
        IllegalArgumentException - Thrown if a channel with the given index already exists
      • numberedNet2Any

        <T> NetSharedChannelInput<T> numberedNet2Any​(int index,
                                                     int immunityLevel)
                                              throws IllegalArgumentException
        Creates a new NetSharedChannelInput with the given index and poison immunity level
        Parameters:
        index - The index to create the channel with
        immunityLevel - The immunity to poison the channel has
        Returns:
        A new NetSharedChannelInput
        Throws:
        IllegalArgumentException - Thrown if a channel with the given index already exists
      • numberedNet2Any

        <T> NetSharedChannelInput<T> numberedNet2Any​(int index,
                                                     NetworkMessageFilter.FilterRx filter)
                                              throws IllegalArgumentException
        Creates a new NetSharedChannelInput with the given index that uses the given filter to decode incoming messages
        Parameters:
        index - The index to create the channel with
        filter - The filter used to decode incoming messages
        Returns:
        A new NetSharedChannelInput
        Throws:
        IllegalArgumentException - Thrown if a channel with the given index already exists
      • numberedNet2Any

        <T> NetSharedChannelInput<T> numberedNet2Any​(int index,
                                                     int immunityLevel,
                                                     NetworkMessageFilter.FilterRx filter)
                                              throws IllegalArgumentException
        Creates a new NetSharedChannelInput with the given index and poison immunity level, which uses the given filter to decode incoming messages.
        Parameters:
        index - The index to create the channel with
        immunityLevel - The immunity level to poison that the channel has
        filter - The filter used to decode incoming messages
        Returns:
        A new NetSharedChannelInput
        Throws:
        IllegalArgumentException - Thrown if a channel with the given index already exists.
      • one2net

        <T> NetChannelOutput<T> one2net​(NetChannelLocation loc)
                                 throws JCSPNetworkException
        Creates a new NetChannelOutput connected to the input end with the given NetChannelLocation
        Parameters:
        loc - The location of the input end of the channel
        Returns:
        A new NetChannelOutput
        Throws:
        JCSPNetworkException - Thrown if something goes wrong in the underlying architecture
      • one2net

        <T> NetChannelOutput<T> one2net​(NetChannelLocation loc,
                                        int immunityLevel)
                                 throws JCSPNetworkException
        Creates a new NetChannelOutput connected to the input end with the given NetChannelLocation, and having the given poison immunity level
        Parameters:
        loc - The location of the input end of the channel
        immunityLevel - The immunity to poison that this channel has
        Returns:
        A new NetChannelOutput
        Throws:
        JCSPNetworkException - Thrown if something goes wrong in the underlying architecture
      • one2net

        <T> NetChannelOutput<T> one2net​(NetChannelLocation loc,
                                        NetworkMessageFilter.FilterTx filter)
                                 throws JCSPNetworkException
        Creates a new NetChannelOutput connected to the input end with the given NetChannelLocation, and uses the given filter to encode outgoing messages
        Parameters:
        loc - The location of the input end of the channel
        filter - The filter used to encode outgoing messages
        Returns:
        A new NetChannelOutput
        Throws:
        JCSPNetworkException - Thrown if something goes wrong in the underlying architecture
      • one2net

        <T> NetChannelOutput<T> one2net​(NetChannelLocation loc,
                                        int immunityLevel,
                                        NetworkMessageFilter.FilterTx filter)
                                 throws JCSPNetworkException
        Creates a new NetChannelOutput connected to the given location with the given poison immunity level, and uses the given filter to encode outgoing messages.
        Parameters:
        loc - The location of the input end of the channel
        immunityLevel - The immunity to poison that this channel has
        filter - The filter used to encode outgoing messages
        Returns:
        A new NetChannelOutput
        Throws:
        JCSPNetworkException - Thrown if something goes wrong in the underlying architecture
      • any2net

        <T> NetSharedChannelOutput<T> any2net​(NetChannelLocation loc,
                                              int immunityLevel)
                                       throws JCSPNetworkException
        Creates a new NetSharedChannelOutput connected to the input end at the given location and with the given poison immunity level
        Parameters:
        loc - The location of the input end of the channel
        immunityLevel - The immunity to poison that the channel has
        Returns:
        A new NetSharedChannelInput
        Throws:
        JCSPNetworkException - Thrown if something goes wrong in the underlying architecture
      • any2net

        <T> NetSharedChannelOutput<T> any2net​(NetChannelLocation loc,
                                              int immunityLevel,
                                              NetworkMessageFilter.FilterTx filter)
                                       throws JCSPNetworkException
        Creates a new NetSharedChannelOutput connected to the input end with the given location and with the given immunity level, which uses the given filter to encode outgoing messages.
        Parameters:
        loc - The location of the input end of the channel
        immunityLevel - The immunity to poison that this channel has
        filter - The filter used to encode outgoing messages
        Returns:
        A new NetSharedChannelOutput
        Throws:
        JCSPNetworkException - Thrown if something goes wrong in the underlying architecture
      • one2net

        <T> NetChannelOutput<T> one2net​(NodeID nodeID,
                                        int vcn)
                                 throws JCSPNetworkException
        Creates a new NetChannelOutput connected to the channel with the given vcn on the given Node
        Parameters:
        nodeID - The NodeID of the node that the input channel resides on
        vcn - The Virtual Channel Number of the input channel
        Returns:
        A new NetChannelOutput
        Throws:
        JCSPNetworkException - Thrown if something goes wrong in the underlying architecture
      • one2net

        <T> NetChannelOutput<T> one2net​(NodeID nodeID,
                                        int vcn,
                                        int immunityLevel)
                                 throws JCSPNetworkException
        Creates a new NetChannelOutput connected to the channel with the given vcn on the given Node, and with the given poison immunity level
        Parameters:
        nodeID - The NodeID of the Node that the input channel resides on
        vcn - The Virtual Channel Number of the input channel
        immunityLevel - The immunity to poison of the channel
        Returns:
        A new NetChannelOutput
        Throws:
        JCSPNetworkException - Thrown if something goes wrong in the underlying architecture
      • one2net

        <T> NetChannelOutput<T> one2net​(NodeID nodeID,
                                        int vcn,
                                        NetworkMessageFilter.FilterTx filter)
                                 throws JCSPNetworkException
        Creates a new NetChannelOutput connected to the channel with the given vcn on the given Node, which uses the given filter to encode outgoing messages
        Parameters:
        nodeID - The NodeID of the Node that the input channel resides on
        vcn - The Virtual Channel Number of the input channel
        filter - The filter to encode outgoing messages
        Returns:
        A new NetChannelOutput
        Throws:
        JCSPNetworkException - Thrown if something goes wrong with the underlying architecture
      • one2net

        <T> NetChannelOutput<T> one2net​(NodeID nodeID,
                                        int vcn,
                                        int immunityLevel,
                                        NetworkMessageFilter.FilterTx filter)
                                 throws JCSPNetworkException
        Creates a new NetChannelOutput connected to the channel with the given vcn on the given Node, with the given poison immunity level and uses the given filter to encode outgoing messages
        Parameters:
        nodeID - The NodeID of the Node that the input channel resides on
        vcn - The Virtual Channel Number of the input channel
        immunityLevel - The immunity to poison that the channel has
        filter - The filter that encodes the outgoing messages
        Returns:
        A new NetChannelOutput
        Throws:
        JCSPNetworkException - Thrown if something goes wrong with the underlying architecture
      • any2net

        <T> NetSharedChannelOutput<T> any2net​(NodeID nodeID,
                                              int vcn)
                                       throws JCSPNetworkException
        Creates a new NetSharedChannelOutput connected to the channel with the given vcn on the given Node
        Parameters:
        nodeID - The NodeID of the Node to connect to
        vcn - The Virtual Channel Number of the input channel
        Returns:
        A new NetSharedChannelOutput
        Throws:
        JCSPNetworkException - Thrown if something goes wrong in the underlying architecture
      • any2net

        <T> NetSharedChannelOutput<T> any2net​(NodeID nodeID,
                                              int vcn,
                                              int immunityLevel)
                                       throws JCSPNetworkException
        Creates a new NetSharedChannelOutput connected to the channel with the given vcn on the given Node and the given poison immunity
        Parameters:
        nodeID - The NodeID of the Node to connect to
        vcn - The Virtual Channel Number of the input channel
        immunityLevel - The immunity to poison that the channel has
        Returns:
        A new NetSharedChannelOutput
        Throws:
        JCSPNetworkException - Thrown if something goes wrong in the underlying architecture
      • any2net

        <T> NetSharedChannelOutput<T> any2net​(NodeID nodeID,
                                              int vcn,
                                              NetworkMessageFilter.FilterTx filter)
                                       throws JCSPNetworkException
        Creates a new NetSharedChannelOutput connected to the channel with the given vcn on the given Node, which uses the given filter to encode outgoing messages
        Parameters:
        nodeID - The NodeID of the Node to connect to
        vcn - The Virtual Channel Number of the input channel
        filter - The filter used to encode the outgoing messages
        Returns:
        A new NetSharedChannelOutput
        Throws:
        JCSPNetworkException - Thrown if something goes wrong in the underlying architecture
      • any2net

        <T> NetSharedChannelOutput<T> any2net​(NodeID nodeID,
                                              int vcn,
                                              int immunityLevel,
                                              NetworkMessageFilter.FilterTx filter)
                                       throws JCSPNetworkException
        Creates a new NetSharedChannelOutput connected to the channel with the given vcn on the given Node, with the given poison immunity level, which uses the given filter to encode outgoing messages
        Parameters:
        nodeID - The NodeID of the Node to connect to
        vcn - The Virtual Channel Number of the input channel
        immunityLevel - The immunity to poison that the channel has
        filter - The filter used to encode outgoing messages
        Returns:
        A new NetSharedChannelOutput
        Throws:
        JCSPNetworkException - Thrown if something goes wrong in the underlying architecture
      • one2net

        <T> NetChannelOutput<T> one2net​(NodeAddress nodeAddr,
                                        int vcn)
                                 throws JCSPNetworkException
        Creates a new NetChannelOutput connected to the channel with the given vcn on the given Node
        Parameters:
        nodeAddr - The NodeAddress of the Node to connect to
        vcn - The Virtual Channel Number of the input channel
        Returns:
        A new NetChannelOutput
        Throws:
        JCSPNetworkException - Thrown if something goes wrong in the underlying architecture
      • one2net

        <T> NetChannelOutput<T> one2net​(NodeAddress nodeAddr,
                                        int vcn,
                                        int immunityLevel)
                                 throws JCSPNetworkException
        Creates a new NetChannelOutput connected to the channel with the given vcn on the given Node with the given poison immunity
        Parameters:
        nodeAddr - The NodeAddress of the Node to connect to
        vcn - The Virtual Channel Number of the input channel
        immunityLevel - The immunity to poison the channel has
        Returns:
        A new NetChannelOutput
        Throws:
        JCSPNetworkException - Thrown if something goes wrong in the underlying architecture
      • one2net

        <T> NetChannelOutput<T> one2net​(NodeAddress nodeAddr,
                                        int vcn,
                                        NetworkMessageFilter.FilterTx filter)
                                 throws JCSPNetworkException
        Creates a new NetChannelOutput connected to the channel with the given vcn on the given Node which uses the given filter to encode outgoing messages
        Parameters:
        nodeAddr - The NodeAddress of the Node to connect to
        vcn - The Virtual Channel Number of the input channel
        filter - The filter used to encode outgoing messages
        Returns:
        A new NetChannelOutput
        Throws:
        JCSPNetworkException - Thrown if something goes wrong in the underlying architecture
      • one2net

        <T> NetChannelOutput<T> one2net​(NodeAddress nodeAddr,
                                        int vcn,
                                        int immunityLevel,
                                        NetworkMessageFilter.FilterTx filter)
                                 throws JCSPNetworkException
        Creates a new NetChannelOutput connected to the channel with the given vcn on the given Node which has the given poison immunity and uses the given filter to encode outgoing messages
        Parameters:
        nodeAddr - The NodeAddress of the Node to connect to
        vcn - The Virtual Channel Number of the input channel
        immunityLevel - The immunity to poison that the channel has
        filter - The filter used to encode outgoing messages
        Returns:
        A new NetChannelOutput
        Throws:
        JCSPNetworkException - Thrown if something goes wrong in the underlying architecture
      • any2net

        <T> NetSharedChannelOutput<T> any2net​(NodeAddress nodeAddr,
                                              int vcn)
                                       throws JCSPNetworkException
        Creates a new NetSharedChannelOutput connected to the channel with the given vcn on the given Node
        Parameters:
        nodeAddr - The NodeAddress of the Node to connect to
        vcn - The Virtual Channel Number of the input channel
        Returns:
        A new NetSharedChannelOutput
        Throws:
        JCSPNetworkException - Thrown if something goes wrong in the underlying architecture
      • any2net

        <T> NetSharedChannelOutput<T> any2net​(NodeAddress nodeAddr,
                                              int vcn,
                                              int immunityLevel)
                                       throws JCSPNetworkException
        Creates a new NetSharedChannelOutput connected to the channel with the given vcn on the given Node which has the given poison immunity
        Parameters:
        nodeAddr - The NodeAddress of the Node to connect to
        vcn - The Virtual Channel Number of the input channel
        immunityLevel - The immunity to poison that the channel has
        Returns:
        A new NetSharedChannelOutput
        Throws:
        JCSPNetworkException - Thrown if something goes wrong in the underlying architecture
      • any2net

        <T> NetSharedChannelOutput<T> any2net​(NodeAddress nodeAddr,
                                              int vcn,
                                              NetworkMessageFilter.FilterTx filter)
                                       throws JCSPNetworkException
        Creates a new NetSharedChannelOutput connected to the channel with the given vcn on the given Node which uses the given filter to encode outgoing messages
        Parameters:
        nodeAddr - The NodeAddress of the Node to connect to
        vcn - The Virtual Channel Number of the input channel
        filter - The immunity to poison that the channel has
        Returns:
        A new NetSharedChannelOutput
        Throws:
        JCSPNetworkException - Thrown if something goes wrong in the underlying architecture
      • any2net

        <T> NetSharedChannelOutput<T> any2net​(NodeAddress nodeAddr,
                                              int vcn,
                                              int immunityLevel,
                                              NetworkMessageFilter.FilterTx filter)
                                       throws JCSPNetworkException
        Creates a new NetSharedChannelOutput connected to the channel with the given vcn on the given Node that has the given poison immunity level and uses the given filter to encode outgoing messages
        Parameters:
        nodeAddr - The NodeAddress of the Node to connect to
        vcn - The Virtual Channel Number of the input channel
        immunityLevel - The immunity to poison that the channel has
        filter - The filter used to encode outgoing messages
        Returns:
        A new NetSharedChannelOutput
        Throws:
        JCSPNetworkException - Thrown if something goes wrong in the underlying architecture