diff options
| author | Kyle Gunger <kgunger12@gmail.com> | 2021-05-31 17:14:46 -0400 |
|---|---|---|
| committer | Kyle Gunger <kgunger12@gmail.com> | 2021-05-31 17:14:46 -0400 |
| commit | 9190d7c12d1bbdcfc401543128fb0219e6fc0a81 (patch) | |
| tree | 15c3a46a936f619ab9ee3d7039e88dbcf1a51d69 /src/main/java/net/cshift/transit/network/Channel.java | |
| parent | 04276d1d18d379248cc02b17c15a28760a5adb41 (diff) | |
alpha.predev.2
Diffstat (limited to 'src/main/java/net/cshift/transit/network/Channel.java')
| -rw-r--r-- | src/main/java/net/cshift/transit/network/Channel.java | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/src/main/java/net/cshift/transit/network/Channel.java b/src/main/java/net/cshift/transit/network/Channel.java index 43dbabc..c7be552 100644 --- a/src/main/java/net/cshift/transit/network/Channel.java +++ b/src/main/java/net/cshift/transit/network/Channel.java @@ -7,7 +7,7 @@ import net.cshift.transit.network.packet.IStaticPacket; * @apiNote A channel represents a connection between two nodes. It is able to send data in packets, and serves as a way to organize incoming traffic. * @param <D> The type of data the packets will be transfering */ -public class Channel<D> { +public final class Channel<D> { private INode to; private int id; private String group; @@ -16,7 +16,7 @@ public class Channel<D> { * Negative IDs indicate a terminated connection, so do not initialize the class with a negative ID. * * @param node The recieving node - * @param id The channel's id, as assigned by the recieving node. + * @param id The channel's id, as assigned by the recieving node. In most cases, this will match the pool ID as a way to match channels to pools. * @param group */ public Channel(INode node, int id, String group) @@ -75,6 +75,7 @@ public class Channel<D> { /** Pressure * + * @apiNote This part of the api is not properly documented yet, and it's use is not reccommended for cross-mod communications. * @return A Number representing the pressure from the channel (in base group units). */ public Number pressure() @@ -84,7 +85,7 @@ public class Channel<D> { /** Max transfer rate * - * @return A Number representing the max transfer rate from the channel (in base group units). + * @return A Number representing the max transfer rate from the channel (in base group units per tick). */ public Number rate() { |