diff options
Diffstat (limited to 'src/main/java/net/cshift/api/transit/network')
7 files changed, 0 insertions, 375 deletions
diff --git a/src/main/java/net/cshift/api/transit/network/Channel.java b/src/main/java/net/cshift/api/transit/network/Channel.java deleted file mode 100644 index 758c7d4..0000000 --- a/src/main/java/net/cshift/api/transit/network/Channel.java +++ /dev/null @@ -1,146 +0,0 @@ -/* - MIT License - - Copyright (c) 2023 Kyle Gunger - - Permission is hereby granted, free of charge, to any person obtaining a copy - of this software and associated documentation files (the "Software"), to deal - in the Software without restriction, including without limitation the rights - to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - copies of the Software, and to permit persons to whom the Software is - furnished to do so, subject to the following conditions: - - The above copyright notice and this permission notice shall be included in all - copies or substantial portions of the Software. - - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - SOFTWARE. -*/ - -package net.cshift.api.transit.network; - -import net.cshift.api.transit.network.packet.IStaticPacket; -import net.cshift.api.transit.type.group.GroupRegistry; -import net.cshift.api.transit.type.group.TypeGroup; - -/** - * @author Kyle Gunger - * @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 final class Channel<D> { - private INode to; - private int id; - private String group; - private Class<D> baseClass; - - /** This constructor should be called by a node approving a connection. The approving node can give the connection an ID and group. - * 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. 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, Class<D> baseClass) - { - to = node; - this.id = id; - this.group = group; - this.baseClass = baseClass; - } - - - - // #################### - // # Channel specific # - // #################### - - /** The recieving INode - * - * @return - */ - public INode getReciever() - { - return to; - } - - /** The ID of the connection, assigned by the recieving INode - * - * @return - */ - public int getID() - { - return id; - } - - /** The group that the channel operates on - * - * @return - */ - public TypeGroup<D> getGroup() { - return GroupRegistry.<D>groupByID(group, baseClass); - } - - /** Returns true if the connection has been terminated - * - * @return - */ - public boolean isTerminated() - { - return id < 0; - } - - - - // ################################ - // # Info from the recieving node # - // ################################ - - /** 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() - { - return to.getPressure(this); - } - - /** Max transfer rate - * - * @return A Number representing the max transfer rate from the channel (in base group units per tick). - */ - public Number rate() - { - return to.getRate(this); - } - - - - // ################################ - // # Interact with the other node # - // ################################ - - /** Terminates the connection and relays the termination to the recieving node - */ - public void terminate() - { - id = -1; - to.onTerminate(this); - } - - /** Send a packet to the recieving node - * - * @param packet the packet to send - * @return The overflow data if the packet is only partially accepted. {@code null} otherwise. - */ - public IStaticPacket<D> send(IStaticPacket<D> packet) - { - return to.<D>accept(packet, this); - } -} diff --git a/src/main/java/net/cshift/api/transit/network/INode.java b/src/main/java/net/cshift/api/transit/network/INode.java deleted file mode 100644 index ad9f1d3..0000000 --- a/src/main/java/net/cshift/api/transit/network/INode.java +++ /dev/null @@ -1,74 +0,0 @@ -package net.cshift.api.transit.network; - -import net.cshift.api.transit.network.packet.*; - -/** - * @author Kyle Gunger - * @apiNote A node inside or outside a system. - */ -public interface INode -{ - /** Returns a pool manifest for the INode - * - */ - public PoolManifest getManifest(); - - - - // ############### - // # Connections # - // ############### - - /** Call this function to establish a specific connection with a node. - * - * @param <T> The type of connection being asked for - * @param poolID The ID of the pool the channel will interface with (see PoolManifest) - * @param asker The asking node - * @return A channel if the node accepts the request, {@code null} otherwise - */ - public <T> Channel<T> connect(int poolID, String group, INode asker); - - /** Call this function to establish a default connection with a node. - * - * @param <T> The type of connection being asked for - * @param group The group that is being connected to - * @param asker The asking node - * @return A channel if the node accepts the request, {@code null} otherwise - */ - public <T> Channel<T> connectDefault(String group, INode asker); - - /** Accept a packet from a channel (or not). - * - * @apiNote Do not call this function, use Channel.send(packet) instead. - * @param <T> The type of the packet and channel - * @param packet The packet to be vetted - * @param channel The channel which the packet is coming through - * @return The overflow data if the packet is only partially accepted. {@code null} otherwise. - */ - public <T> IStaticPacket<T> accept(IStaticPacket<T> packet, Channel<T> channel); - - /** Pressure - * - * @apiNote Do not call this function, use Channel.pressure() instead. - * @param channel The channel asking for the pressure - * @return A Number representing the pressure from the channel (in base group units). - */ - public <T> Number getPressure(Channel<T> channel); - - /** Transfer rate - * - * @apiNote Do not call this function, use Channel.rate() instead. - * @param channel The channel asking for the transfer rate - * @return A Number representing the transfer rate from the channel (in base group units per tick). - */ - public <T> Number getRate(Channel<T> channel); - - /** Called when a channel is terminated - * - * @apiNote Do not call this function, use Channel.terminate() instead. - * @param <T> The type of the channel - * @param channel The channel being terminated - */ - public <T> void onTerminate(Channel<T> channel); - -} diff --git a/src/main/java/net/cshift/api/transit/network/PoolManifest.java b/src/main/java/net/cshift/api/transit/network/PoolManifest.java deleted file mode 100644 index e539ee1..0000000 --- a/src/main/java/net/cshift/api/transit/network/PoolManifest.java +++ /dev/null @@ -1,42 +0,0 @@ -package net.cshift.api.transit.network; - -/** - * @author Kyle Gunger - * @apiNote A pool manifest represents a set of possible data/resource pools that another node can request a channel to. - */ -public abstract class PoolManifest { - - /** Represents the number of pools that the node has access to. - * @apiNote A "pool" in this context represents an independent network of resources. - * Each network in the pool may represent a different TypeGroup. - * Pool zero should be the default group that simple nodes will attempt to connect to. - * @param group The TypeGroup that the pool belongs to - */ - public abstract int poolCount(); - - /** If the mod supports named pools, the names can be queried through this function. - * - * @param group The TypeGroup the pool belongs to - * @param pool Array-like index for pool (gotten from poolCount) - */ - public String poolName(int pool) { - return ""; - } - - /** Returns true if the pool with the given id supports the given group - * - * @param pool The pool ID to query - * @param group The TypeGroup to query - * @return {@code true} if the pool supports the specified group, {@code false} otherwise - */ - public abstract boolean poolProvides(int pool, String group); - - /** If the mod supports pool descriptions, they can be accessed by this method. - * - * @param group The TypeGroup the pool belongs to - * @param pool Array-like index for pool (gotten from poolCount) - */ - public String poolDescription(int pool) { - return ""; - } -} diff --git a/src/main/java/net/cshift/api/transit/network/packet/DynamicPacket.java b/src/main/java/net/cshift/api/transit/network/packet/DynamicPacket.java deleted file mode 100644 index 3a57227..0000000 --- a/src/main/java/net/cshift/api/transit/network/packet/DynamicPacket.java +++ /dev/null @@ -1,43 +0,0 @@ -package net.cshift.api.transit.network.packet; - -import net.cshift.api.transit.type.Type; - -/** - * Simple packet which stores a value which can change. - * - * @param <D> The type parameter of the Type being transported - * @author Kyle Gunger - * - */ -public class DynamicPacket<D> implements IDynamicPacket<D> { - private Object data; - private Type<D> type; - - /** Constructor. Stores the given data and uses the given type. - * - * @param dat The packet's data - * @param t The packet's type - */ - public DynamicPacket(Object dat, Type<D> t) - { - data = dat; - type = t; - } - - @Override - public Object getData() - { - return data; - } - - @Override - public void setData(Object dat) - { - data = dat; - } - - @Override - public Type<D> getType() { - return type; - } -} diff --git a/src/main/java/net/cshift/api/transit/network/packet/IDynamicPacket.java b/src/main/java/net/cshift/api/transit/network/packet/IDynamicPacket.java deleted file mode 100644 index 6d80b3b..0000000 --- a/src/main/java/net/cshift/api/transit/network/packet/IDynamicPacket.java +++ /dev/null @@ -1,11 +0,0 @@ -package net.cshift.api.transit.network.packet; - -/** Interface describing a packet where the data can change as it's transferred. - * - * @param <D> The type parameter of the Type being transported - * @author Kyle Gunger - */ -public interface IDynamicPacket<D> extends IStaticPacket<D>{ - /** Set the packet's data. */ - public void setData(Object dat); -} diff --git a/src/main/java/net/cshift/api/transit/network/packet/IStaticPacket.java b/src/main/java/net/cshift/api/transit/network/packet/IStaticPacket.java deleted file mode 100644 index cdad90a..0000000 --- a/src/main/java/net/cshift/api/transit/network/packet/IStaticPacket.java +++ /dev/null @@ -1,23 +0,0 @@ -package net.cshift.api.transit.network.packet; - -import net.cshift.api.transit.type.*; - -/** Interface describing an unchanging packet. - * - * @param <D> The type parameter of the Type being transported - * @author Kyle Gunger - */ -public interface IStaticPacket<D> -{ - /**Get the packet's data. - * - * @return The packet's data - */ - public Object getData(); - - /**Get the packet's type. - * - * @return IType<?> The type of the packet - */ - public Type<D> getType(); -} diff --git a/src/main/java/net/cshift/api/transit/network/packet/StaticPacket.java b/src/main/java/net/cshift/api/transit/network/packet/StaticPacket.java deleted file mode 100644 index 5ffed26..0000000 --- a/src/main/java/net/cshift/api/transit/network/packet/StaticPacket.java +++ /dev/null @@ -1,36 +0,0 @@ -package net.cshift.api.transit.network.packet; - -import net.cshift.api.transit.type.*; - -/** Simple packet which stores an unchanging value. - * @author Kyle Gunger - * - * @param <D> The data type (Object) that the packet transfers. - */ -public class StaticPacket<D> implements IStaticPacket<D> -{ - private Object data; - private Type<D> type; - - /** Constructor. Stores the given data and uses the given type. - * - * @param dat The packet's data - * @param t The packet's type - */ - public StaticPacket(Object dat, Type<D> t) - { - data = dat; - type = t; - } - - @Override - public Object getData() - { - return data; - } - - @Override - public Type<D> getType() { - return type; - } -} |