dan200.computercraft.api.network.wired

Interface IWiredNetwork

public interface IWiredNetwork

A wired network is composed of one of more IWiredNodes, a set of connections between them, and a series of peripherals. Networks from a connected graph. This means there is some path between all nodes on the network. Further more, if there is some path between two nodes then they must be on the same network. IWiredNetwork will automatically handle the merging and splitting of networks (and thus changing of available nodes and peripherals) as connections change. This does mean one can not rely on the network remaining consistent between subsequent operations. Consequently, it is generally preferred to use the methods provided by IWiredNode.

See Also:

IWiredNode.getNetwork()

Method Summary

Modifier and Type	Method and Description
boolean	connect(IWiredNode left, IWiredNode right) Create a connection between two nodes.
boolean	disconnect(IWiredNode left, IWiredNode right) Destroy a connection between this node and another.
boolean	remove(IWiredNode node) Sever all connections this node has, removing it from this network.
void	updatePeripherals(IWiredNode node, java.util.Map<java.lang.String,IPeripheral> peripherals) Update the peripherals a node provides.

Method Detail

connect

boolean connect(@Nonnull
                IWiredNode left,
                @Nonnull
                IWiredNode right)

Create a connection between two nodes. This should only be used on the server thread.

Parameters:

left - The first node to connect

right - The second node to connect

Returns:

true if a connection was created or false if the connection already exists.

Throws:

java.lang.IllegalStateException - If neither node is on the network.

java.lang.IllegalArgumentException - If left and right are equal.

See Also:

IWiredNode.connectTo(IWiredNode), connect(IWiredNode, IWiredNode)

disconnect

boolean disconnect(@Nonnull
                   IWiredNode left,
                   @Nonnull
                   IWiredNode right)

Destroy a connection between this node and another. This should only be used on the server thread.

Parameters:

left - The first node in the connection.

right - The second node in the connection.

Returns:

true if a connection was destroyed or false if no connection exists.

Throws:

java.lang.IllegalArgumentException - If either node is not on the network.

java.lang.IllegalArgumentException - If left and right are equal.

See Also:

IWiredNode.disconnectFrom(IWiredNode), connect(IWiredNode, IWiredNode)

remove

boolean remove(@Nonnull
               IWiredNode node)

Sever all connections this node has, removing it from this network. This should only be used on the server thread. You should only call this on nodes that your network element owns.

Parameters:

node - The node to remove

Returns:

Whether this node was removed from the network. One cannot remove a node from a network where it is the only element.

Throws:

java.lang.IllegalArgumentException - If the node is not in the network.

See Also:

IWiredNode.remove()

updatePeripherals

void updatePeripherals(@Nonnull
                       IWiredNode node,
                       @Nonnull
                       java.util.Map<java.lang.String,IPeripheral> peripherals)

Update the peripherals a node provides. This should only be used on the server thread. You should only call this on nodes that your network element owns.

Parameters:

node - The node to attach peripherals for.

peripherals - The new peripherals for this node.

Throws:

java.lang.IllegalArgumentException - If the node is not in the network.

See Also:

IWiredNode.updatePeripherals(Map)