summaryrefslogtreecommitdiff
path: root/src/main/java/net/transit/network/swap
diff options
context:
space:
mode:
authorKyle Gunger <kgunger12@gmail.com>2019-11-21 18:35:14 -0500
committerKyle Gunger <kgunger12@gmail.com>2019-11-21 18:35:14 -0500
commitd08cbf6b8705df234077c49608de3c2f7ff0e3fa (patch)
tree6e8705d65e4e0f0c1cafe9736980504b5b6f9cde /src/main/java/net/transit/network/swap
parentdf044930bca4252ff6e4814c654a612c6aee2136 (diff)
[Update] Codebase updated to 0.2.8
~ Rewrote files and documentation for cohesion ~ Removed I from the start of interface names
Diffstat (limited to 'src/main/java/net/transit/network/swap')
-rw-r--r--src/main/java/net/transit/network/swap/Acceptor.java44
-rw-r--r--src/main/java/net/transit/network/swap/IAcceptor.java31
-rw-r--r--src/main/java/net/transit/network/swap/IProvider.java37
-rw-r--r--src/main/java/net/transit/network/swap/Provider.java50
4 files changed, 94 insertions, 68 deletions
diff --git a/src/main/java/net/transit/network/swap/Acceptor.java b/src/main/java/net/transit/network/swap/Acceptor.java
new file mode 100644
index 0000000..9778095
--- /dev/null
+++ b/src/main/java/net/transit/network/swap/Acceptor.java
@@ -0,0 +1,44 @@
+package net.transit.network.swap;
+
+import net.transit.network.packet.Packet;
+import net.transit.network.system.Node;
+
+/**
+ * @author Kyle Gunger
+ *
+ * @param <T> The type of data accepted (in IPacket<<T>> form)
+ */
+public interface Acceptor<T>
+{
+ /** Returns the INode this Acceptor is attached to. All Acceptors and Provider must be attached to an INode to function.
+ *
+ * @return INode
+ */
+ public Node getNode();
+
+ /**
+ * @return <b>True</b> if the Acceptor can accept packets.
+ */
+ public boolean canAccept();
+
+ /**
+ * @param provided The packet provided.
+ * @return <b>True</b> if the Acceptor accepted the packet.
+ */
+ public boolean accept(Packet<T> provided);
+
+ /**
+ * @return <b>True</b> if the Acceptor has a Provider assigned to it.
+ */
+ public boolean hasProvider();
+
+ /**Set the provider of the Acceptor. The Acceptor can decide if it wants to adopt the Provider.
+ */
+ public void setProvider(Provider<T> provider);
+
+ /** Request that the Acceptor close it's connection to a Provider. The Acceptor may also shut itself down if no more Providers are attached.
+ *
+ * @param provider The Provider
+ */
+ public void shutdown(Provider<T> provider);
+} \ No newline at end of file
diff --git a/src/main/java/net/transit/network/swap/IAcceptor.java b/src/main/java/net/transit/network/swap/IAcceptor.java
deleted file mode 100644
index 6966b9a..0000000
--- a/src/main/java/net/transit/network/swap/IAcceptor.java
+++ /dev/null
@@ -1,31 +0,0 @@
-package net.transit.network.swap;
-
-import net.transit.network.packet.IPacket;
-
-/**
- * @author Kyle Gunger
- *
- * @param <T> The type of data accepted (in IPacket<<T>> form)
- */
-public interface IAcceptor<T>
-{
- /**
- * @return <b>True</b> if the acceptor can accept packets.
- */
- public boolean canAccept();
-
- /**
- * @param provided The packet provided.
- * @return <b>True</b> if the acceptor accepted the packet.
- */
- public boolean accept(IPacket<T> provided);
-
- /**
- * @return <b>True</b> if the acceptor has a provider assigned to it.
- */
- public boolean hasProvider();
-
- /**Set the provider of the acceptor. The acceptor can decide if it wants to adopt the provider.
- */
- public void setProvider(IProvider<T> provider);
-} \ No newline at end of file
diff --git a/src/main/java/net/transit/network/swap/IProvider.java b/src/main/java/net/transit/network/swap/IProvider.java
deleted file mode 100644
index 03c9ca9..0000000
--- a/src/main/java/net/transit/network/swap/IProvider.java
+++ /dev/null
@@ -1,37 +0,0 @@
-package net.transit.network.swap;
-
-import net.transit.network.packet.IPacket;
-
-/**
- * @author Kyle Gunger
- *
- * @param <T> The type of data provided (in IPacket<<T>> form)
- */
-public interface IProvider<T>
-{
- /**
- * @return <b>True</b> if the provider can provide a packet.
- */
- public boolean canProvide();
-
- /**Get the next packet from the provider
- *
- * @return IPacket<<T>>
- */
- public IPacket<T> provide();
-
- /**Retain the packet if the acceptor did not accept the packet.
- *
- * @param rejected The rejected packet
- */
- public void retain(IPacket<T> rejected);
-
- /**
- * @return <b>True</b> if the acceptor has a provider assigned to it
- */
- public boolean hasAcceptor();
-
- /**Set the acceptor of the provider. The provider can decide if it wants to adopt the acceptor.
- */
- public void setAcceptor();
-} \ No newline at end of file
diff --git a/src/main/java/net/transit/network/swap/Provider.java b/src/main/java/net/transit/network/swap/Provider.java
new file mode 100644
index 0000000..20656b8
--- /dev/null
+++ b/src/main/java/net/transit/network/swap/Provider.java
@@ -0,0 +1,50 @@
+package net.transit.network.swap;
+
+import net.transit.network.packet.Packet;
+import net.transit.network.system.Node;
+
+/**
+ * @author Kyle Gunger
+ *
+ * @param <T> The type of data provided (in IPacket<<T>> form)
+ */
+public interface Provider<T>
+{
+ /** Returns the INode this Provider is attached to. All Acceptors and Providers must be attached to an INode to function.
+ *
+ * @return INode
+ */
+ public Node getNode();
+
+ /**
+ * @return <b>True</b> if the Provider can provide a packet.
+ */
+ public boolean canProvide();
+
+ /**Get the next packet from the Provider
+ *
+ * @return IPacket<<T>>
+ */
+ public Packet<T> provide();
+
+ /**Retain the packet if the Acceptor did not accept the packet.
+ *
+ * @param rejected The rejected packet
+ */
+ public void retain(Packet<T> rejected);
+
+ /**
+ * @return <b>True</b> if the Provider has an Acceptor assigned to it
+ */
+ public boolean hasAcceptor();
+
+ /**Set the Acceptor of the Provider. The Provider can decide if it wants to adopt the Acceptor.
+ */
+ public void setAcceptor(Acceptor<T> acceptor);
+
+ /** Request that the Provider close it's connection to a Acceptor. The Provider may also shut itself down if no more Acceptors are attached.
+ *
+ * @param acceptor The Acceptor
+ */
+ public void shutdown(Acceptor<T> acceptor);
+} \ No newline at end of file