diff --git a/dist/oocsi.zip b/dist/oocsi.zip
index ca202b3..b9d6713 100644
Binary files a/dist/oocsi.zip and b/dist/oocsi.zip differ
diff --git a/dist/oocsi/examples/Connectivity/SendResponseChannel/SendResponseChannel.pde b/dist/oocsi/examples/Connectivity/SendResponseChannel/SendResponseChannel.pde
new file mode 100644
index 0000000..4f5502d
--- /dev/null
+++ b/dist/oocsi/examples/Connectivity/SendResponseChannel/SendResponseChannel.pde
@@ -0,0 +1,93 @@
+import nl.tue.id.oocsi.*;
+import nl.tue.id.oocsi.client.services.*;
+
+// ******************************************************
+// This example requires a running OOCSI server!
+//
+// How to do that? Check: Examples > Tools > LocalServer
+//
+// More information how to run an OOCSI server
+// can be found here: https://iddi.github.io/oocsi/)
+// ******************************************************
+
+// variables for fill color and size of rectangle
+int fillColor = 255;
+int size = 3;
+
+OOCSI oocsi1;
+
+// second OOCSI instance for making calls to the registered handlers
+OOCSI oocsi2;
+
+void setup() {
+ size(200, 200);
+ noStroke();
+ rectMode(CENTER);
+
+ // connect to OOCSI server running on the same machine (localhost)
+ // with "receiverName" to be my channel others can send data to
+ // (for more information how to run an OOCSI server refer to: https://iddi.github.io/oocsi/)
+ oocsi1 = new OOCSI(this, "channel_responder", "localhost");
+
+ // register this first OOCSI client for responses
+ // to call "numberNumer"
+ oocsi1.registerChannel("colorChannel", "newNumber");
+ // and "newColor"
+ oocsi1.registerChannel("colorChannel", "newColor");
+
+ // register can take also the name of the function as an optional second parameter:
+ // oocsi1.register("newColor", "generateColor");
+
+ // ---------------------------------------------------------------------------------
+
+ // connect with a second OOCSI client for calling the first one
+ oocsi2 = new OOCSI(this, "caller", "localhost");
+}
+
+// responder for calls to "newNumber", will receive the call message and then put the response data into
+// the response OOCSIData object, which is same as for OOCSI events and messages
+void newNumber(OOCSIEvent event, OOCSIData response) {
+ response.data("number", frameCount % 20);
+}
+
+// responder for calls to "newColor", will receive the call message and then put the response data into
+// the response OOCSIData object, which is same as for OOCSI events and messages
+void newColor(OOCSIEvent event, OOCSIData response) {
+ int col = event.getInt("color", 0);
+ response.data("color", (fillColor + col) % 255);
+}
+
+void draw() {
+ background(0);
+
+ // draw a rect with the given size and fill color
+ fill(fillColor, 120, 120);
+ rect(width/2., height/2., 5 * size, 5 * size);
+}
+
+void mousePressed() {
+
+ // on mouse press call two different services and get new data...
+
+ // first one for getting a new size
+ // 1: create call
+ OOCSICall call1 = oocsi2.call("colorChannel", "newNumber", 200);
+ // 2: send out and wait until either there is a response or the timeout has passed
+ call1.sendAndWait();
+ // 3: check for response
+ if (call1.hasResponse()) {
+ // 4: get data out of the first response
+ size = call1.getFirstResponse().getInt("number", 0);
+ }
+
+ // second one for getting a new color
+ // 1: create call with parameter "color", similar to normal OOCSI events
+ OOCSICall call2 = oocsi2.call("colorChannel", "newColor", 200).data("color", frameCount);
+ // 2: send out and wait until either there is a response or the timeout has passed
+ call2.sendAndWait();
+ // 3: check for response
+ if (call2.hasResponse()) {
+ // 4: get data out of the first response
+ fillColor = call2.getFirstResponse().getInt("color", 0);
+ }
+}
\ No newline at end of file
diff --git a/dist/oocsi/library.properties b/dist/oocsi/library.properties
index 18c2125..f4112a8 100644
--- a/dist/oocsi/library.properties
+++ b/dist/oocsi/library.properties
@@ -40,11 +40,11 @@ paragraph = This library provides easy ways to connect a Processing sketch to a
# compare different versions of the same library, and check if an update is
# available. You should think of it as a counter, counting the total number of
# releases you've had.
-version = 136
+version = 137
# The version as the user will see it. If blank, the version attribute will be
# used here. This should be a single word, with no spaces.
-prettyVersion = 1.3.6
+prettyVersion = 1.3.7
# The min and max revision of Processing compatible with your library.
# Note that these fields use the revision and not the version of Processing,
diff --git a/dist/oocsi/library/oocsi.jar b/dist/oocsi/library/oocsi.jar
index f1b8b29..0a1fd24 100644
Binary files a/dist/oocsi/library/oocsi.jar and b/dist/oocsi/library/oocsi.jar differ
diff --git a/dist/oocsi/reference/allclasses-frame.html b/dist/oocsi/reference/allclasses-frame.html
index 865aa35..07eb08b 100644
--- a/dist/oocsi/reference/allclasses-frame.html
+++ b/dist/oocsi/reference/allclasses-frame.html
@@ -2,9 +2,9 @@
-
+
All Classes
-
+
diff --git a/dist/oocsi/reference/allclasses-noframe.html b/dist/oocsi/reference/allclasses-noframe.html
index 0e4e144..9186004 100644
--- a/dist/oocsi/reference/allclasses-noframe.html
+++ b/dist/oocsi/reference/allclasses-noframe.html
@@ -2,9 +2,9 @@
-
+
All Classes
-
+
diff --git a/dist/oocsi/reference/constant-values.html b/dist/oocsi/reference/constant-values.html
index b13f230..f46ec8f 100644
--- a/dist/oocsi/reference/constant-values.html
+++ b/dist/oocsi/reference/constant-values.html
@@ -2,9 +2,9 @@
-
+
Constant Field Values
-
+
@@ -122,7 +122,7 @@
rate limited event handler for events with structured data that will only let through events per
+
rate limited event handler for events with structured data that will only let through "rate" events per "second"
secs; this counts for all incoming events per sender which protects against single senders overloading the system
rate limited event handler for events with structured data that will only let through events per
+
rate limited event handler for events with structured data that will only let through "rate" events per "second"
secs; this counts for all incoming events
subscribe to channel for handler method in the parent class; the handler method
+
subscribe to channel "responderName" for handler method "responderName" in the parent class; the handler method
will be called with an OOCSIEvent object and a response map object upon occurrence of an event; will try
- 'respondToOOCSIEvent' as a fall-back in case no matching handler method is found for
+ 'respondToOOCSIEvent' as a fall-back in case no matching handler method is found for "responderName"
register a handler method in the parent class with the given name for the channel ;
+
register a handler method in the parent class with the given name "handlerName" for the channel "channelName";
+ the handler method will be called with an OOCSIEvent object upon occurrence of an event
register a responder "responderName" on channel "channelName"; requires a method with the responder name
+ "responderName" with parameters (OOCSIEvent, OOCSIData)
register a responder "responderName" on channel "channelName"; requires a method with the given name
+ "responderName" with parameters (OOCSIEvent, OOCSIData)
subscribe to channel "responderName" for handler method "responderName" in the parent class; the handler method
+ will be called with an OOCSIEvent object and a response map object upon occurrence of an event; will try
+ 'respondToOOCSIEvent' as a fall-back in case no matching handler method is found for "responderName"
register a handler method in the parent class with the given name "handlerName" for the channel "channelName";
the handler method will be called with an OOCSIEvent object upon occurrence of an event
subscribe to a channel with a given handler method name ; limits the rate of incoming events to
- events per secs; controls whether we limit the rate of incoming event per sender
+
subscribe to a channel with a given handler method name "handlerName"; limits the rate of incoming events to
+ "rate" events per "seconds" secs; "ratePerSender" controls whether we limit the rate of incoming event per sender
or for all events coming in from all senders
subscribe to channel for handler method in the parent class; the handler method will
+
subscribe to channel "channelName" for handler method "channelName" in the parent class; the handler method will
be called with an OOCSIEvent object upon occurrence of an event; will try 'handleOOCSIEvent' as a fall-back in
- case no matching handler method is found for
+ case no matching handler method is found for "channelName"
subscribe to channel for handler method in the parent class with the given name ; the
+
subscribe to channel "channelName" for handler method in the parent class with the given name "handlerName"; the
handler method will be called with an OOCSIEvent object upon occurrence of an event
subscribe to channel for handler method in the parent class with the given name ; the
+
subscribe to channel "channelName" for handler method in the parent class with the given name "handlerName"; the
handler method will be called with an OOCSIEvent object upon occurrence of an event
subscribe to channel for handler method in the parent class with the given name ; the
+
subscribe to channel "channelName" for handler method in the parent class with the given name "handlerName"; the
handler method will be called with an OOCSIEvent object upon occurrence of an event
register a responder "responderName" on channel "channelName"; requires a method with the responder name
+ "responderName" with parameters (OOCSIEvent, OOCSIData)
register a responder "responderName" on channel "channelName"; requires a method with the given name
+ "responderName" with parameters (OOCSIEvent, OOCSIData)
subscribe to a channel with a given handler method name
+
subscribe to a channel with a given handler method name "handlerName"
-
+
void
subscribe(java.lang.String channelName,
java.lang.String handlerName,
int rate,
int seconds)
-
subscribe to a channel with a given handler method name ; limits the rate of incoming events to
- events per secs
+
subscribe to a channel with a given handler method name "handlerName"; limits the rate of incoming events to
+ "rate" events per "seconds" secs
-
+
void
subscribe(java.lang.String channelName,
java.lang.String handlerName,
int rate,
int seconds,
boolean ratePerSender)
-
subscribe to a channel with a given handler method name ; limits the rate of incoming events to
- events per secs; controls whether we limit the rate of incoming event per sender
+
subscribe to a channel with a given handler method name "handlerName"; limits the rate of incoming events to
+ "rate" events per "seconds" secs; "ratePerSender" controls whether we limit the rate of incoming event per sender
or for all events coming in from all senders
public OOCSICall call(java.lang.String channelName,
+ java.lang.String callName,
+ int timeoutMS,
+ int maxResponses)
+
create a call for service method "callName" with a specific timeout on channel "channelName"
Parameters:
+
channelName -
callName -
timeoutMS -
maxResponses -
@@ -599,7 +714,7 @@
subscribe
subscribe
public void subscribe(java.lang.String channelName,
java.lang.String handlerName)
-
subscribe to a channel with a given handler method name
+
subscribe to a channel with a given handler method name "handlerName"
Parameters:
channelName -
@@ -617,8 +732,8 @@
subscribe
java.lang.String handlerName,
int rate,
int seconds)
-
subscribe to a channel with a given handler method name ; limits the rate of incoming events to
- events per secs
+
subscribe to a channel with a given handler method name "handlerName"; limits the rate of incoming events to
+ "rate" events per "seconds" secs
Parameters:
channelName -
@@ -639,8 +754,8 @@
subscribe
int rate,
int seconds,
boolean ratePerSender)
-
subscribe to a channel with a given handler method name ; limits the rate of incoming events to
- events per secs; controls whether we limit the rate of incoming event per sender
+
subscribe to a channel with a given handler method name "handlerName"; limits the rate of incoming events to
+ "rate" events per "seconds" secs; "ratePerSender" controls whether we limit the rate of incoming event per sender
or for all events coming in from all senders
Parameters:
@@ -674,9 +789,46 @@
register
register
public void register(java.lang.String responderName,
java.lang.String responderFunctionName)
-
register a responder; requires a method with the given responderName with parameters (OOCSIEvent, OOCSIData)
+
register a responder "responderName"; requires a method with the given name "responderName" with parameters
+ (OOCSIEvent, OOCSIData)
public void registerChannel(java.lang.String channelName,
+ java.lang.String responderName)
+
register a responder "responderName" on channel "channelName"; requires a method with the responder name
+ "responderName" with parameters (OOCSIEvent, OOCSIData)
public void registerChannel(java.lang.String channelName,
+ java.lang.String responderName,
+ java.lang.String responderFunctionName)
+
register a responder "responderName" on channel "channelName"; requires a method with the given name
+ "responderName" with parameters (OOCSIEvent, OOCSIData)
subscribe to channel for handler method in the parent class; the handler method
+
subscribe to channel "responderName" for handler method "responderName" in the parent class; the handler method
will be called with an OOCSIEvent object and a response map object upon occurrence of an event; will try
- 'respondToOOCSIEvent' as a fall-back in case no matching handler method is found for
+ 'respondToOOCSIEvent' as a fall-back in case no matching handler method is found for "responderName"
register a handler method in the parent class with the given name for the channel ;
+
register a handler method in the parent class with the given name "handlerName" for the channel "channelName";
the handler method will be called with an OOCSIEvent object upon occurrence of an event
subscribe to channel "responderName" for handler method "responderName" in the parent class; the handler method
+ will be called with an OOCSIEvent object and a response map object upon occurrence of an event; will try
+ 'respondToOOCSIEvent' as a fall-back in case no matching handler method is found for "responderName"
register a handler method in the parent class with the given name "handlerName" for the channel "channelName";
+ the handler method will be called with an OOCSIEvent object upon occurrence of an event
subscribe to channel for handler method in the parent class; the handler method will
+
subscribe to channel "channelName" for handler method "channelName" in the parent class; the handler method will
be called with an OOCSIEvent object upon occurrence of an event; will try 'handleOOCSIEvent' as a fall-back in
- case no matching handler method is found for
+ case no matching handler method is found for "channelName"
subscribe to channel for handler method in the parent class with the given name ; the
+
subscribe to channel "channelName" for handler method in the parent class with the given name "handlerName"; the
handler method will be called with an OOCSIEvent object upon occurrence of an event
-
+
boolean
subscribe(java.lang.String channelName,
java.lang.String handlerName,
int rate,
int seconds)
-
subscribe to channel for handler method in the parent class with the given name ; the
+
subscribe to channel "channelName" for handler method in the parent class with the given name "handlerName"; the
handler method will be called with an OOCSIEvent object upon occurrence of an event
-
+
boolean
subscribe(java.lang.String channelName,
java.lang.String handlerName,
int rate,
int seconds,
boolean ratePerSender)
-
subscribe to channel for handler method in the parent class with the given name ; the
+
subscribe to channel "channelName" for handler method in the parent class with the given name "handlerName"; the
handler method will be called with an OOCSIEvent object upon occurrence of an event
@@ -280,7 +322,7 @@
Method Summary
Methods inherited from class nl.tue.id.oocsi.client.OOCSIClient
public OOCSICall call(java.lang.String channelName,
+ java.lang.String callName,
+ int timeoutMS,
+ int maxResponses)
+
create a call for service method "callName" with a specific timeout on channel "channelName"
Parameters:
+
channelName -
callName -
timeoutMS -
maxResponses -
@@ -434,9 +533,9 @@
call
subscribe
public boolean subscribe(java.lang.String channelName)
-
subscribe to channel for handler method in the parent class; the handler method will
+
subscribe to channel "channelName" for handler method "channelName" in the parent class; the handler method will
be called with an OOCSIEvent object upon occurrence of an event; will try 'handleOOCSIEvent' as a fall-back in
- case no matching handler method is found for
+ case no matching handler method is found for "channelName"
Parameters:
channelName -
@@ -452,7 +551,7 @@
subscribe
subscribe
public boolean subscribe(java.lang.String channelName,
java.lang.String handlerName)
-
subscribe to channel for handler method in the parent class with the given name ; the
+
subscribe to channel "channelName" for handler method in the parent class with the given name "handlerName"; the
handler method will be called with an OOCSIEvent object upon occurrence of an event
Parameters:
@@ -472,7 +571,7 @@
subscribe
java.lang.String handlerName,
int rate,
int seconds)
-
subscribe to channel for handler method in the parent class with the given name ; the
+
subscribe to channel "channelName" for handler method in the parent class with the given name "handlerName"; the
handler method will be called with an OOCSIEvent object upon occurrence of an event
Parameters:
@@ -495,7 +594,7 @@
subscribe
int rate,
int seconds,
boolean ratePerSender)
-
subscribe to channel for handler method in the parent class with the given name ; the
+
subscribe to channel "channelName" for handler method in the parent class with the given name "handlerName"; the
handler method will be called with an OOCSIEvent object upon occurrence of an event
Parameters:
@@ -531,9 +630,9 @@
createSimpleCallerHandler
register
public boolean register(java.lang.String responderName)
-
subscribe to channel for handler method in the parent class; the handler method
+
subscribe to channel "responderName" for handler method "responderName" in the parent class; the handler method
will be called with an OOCSIEvent object and a response map object upon occurrence of an event; will try
- 'respondToOOCSIEvent' as a fall-back in case no matching handler method is found for
+ 'respondToOOCSIEvent' as a fall-back in case no matching handler method is found for "responderName"
Parameters:
responderName -
@@ -544,15 +643,54 @@
register
-
+
register
public boolean register(java.lang.String responderName,
java.lang.String handlerName)
-
register a handler method in the parent class with the given name for the channel ;
+
register a handler method in the parent class with the given name "handlerName" for the channel "channelName";
+ the handler method will be called with an OOCSIEvent object upon occurrence of an event
public boolean registerChannel(java.lang.String channelName,
+ java.lang.String responderName)
+
subscribe to channel "responderName" for handler method "responderName" in the parent class; the handler method
+ will be called with an OOCSIEvent object and a response map object upon occurrence of an event; will try
+ 'respondToOOCSIEvent' as a fall-back in case no matching handler method is found for "responderName"
public boolean registerChannel(java.lang.String channelName,
+ java.lang.String responderName,
+ java.lang.String handlerName)
+
register a handler method in the parent class with the given name "handlerName" for the channel "channelName";
the handler method will be called with an OOCSIEvent object upon occurrence of an event
creates a periodic feedback loop that feed either the last input value or the reference value into the variable
(locally). If there is no reference value set, the former applies. The period is given in milliseconds. In
- addition, the new value of the variable is sent out to the channel with the given key
+ addition, the new value of the variable is sent out to the channel "outputChannel" with the given key "outputKey"
creates a periodic feedback loop that feed either the last input value or the reference value into the variable
(locally). If there is no reference value set, the former applies. The period is given in milliseconds. In
- addition, the new value of the variable is sent out to the channel with the given key
+ addition, the new value of the variable is sent out to the channel "outputChannel" with the given key "outputKey"
creates a periodic feedback loop that feed either the last input value or the reference value into the variable
(locally). If there is no reference value set, the former applies. The period is given in milliseconds. In
- addition, the new value of the variable is sent out to the channel with the given key
+ addition, the new value of the variable is sent out to the channel "outputChannel" with the given key "outputKey"
creates a periodic feedback loop that feed either the last input value or the reference value into the variable
(locally). If there is no reference value set, the former applies. The period is given in milliseconds. In
- addition, the new value of the variable is sent out to the channel with the given key
+ addition, the new value of the variable is sent out to the channel "outputChannel" with the given key "outputKey"
set the limiting of incoming events in terms of and timeframe; supports chained invocation
+
set the limiting of incoming events in terms of "rate" and "seconds" timeframe; supports chained invocation
Parameters:
rate -
@@ -844,7 +844,6 @@
smooth
Parameters:
windowLength -
-
sigma -
Returns:
@@ -897,7 +896,7 @@
generator
java.lang.String outputKey)
creates a periodic feedback loop that feed either the last input value or the reference value into the variable
(locally). If there is no reference value set, the former applies. The period is given in milliseconds. In
- addition, the new value of the variable is sent out to the channel with the given key
+ addition, the new value of the variable is sent out to the channel "outputChannel" with the given key "outputKey"
rate limited event handler for events with structured data that will only let through events per
+
rate limited event handler for events with structured data that will only let through "rate" events per "second"
secs; this counts for all incoming events per sender which protects against single senders overloading the system
public abstract class RateLimitedEventHandler
extends EventHandler
-
rate limited event handler for events with structured data that will only let through events per
+
rate limited event handler for events with structured data that will only let through "rate" events per "second"
secs; this counts for all incoming events
rate limited event handler for events with structured data that will only let through events per
+
rate limited event handler for events with structured data that will only let through "rate" events per "second"
secs; this counts for all incoming events per sender which protects against single senders overloading the system
rate limited event handler for events with structured data that will only let through events per
+
rate limited event handler for events with structured data that will only let through "rate" events per "second"
secs; this counts for all incoming events
diff --git a/dist/oocsi/reference/nl/tue/id/oocsi/client/socket/package-frame.html b/dist/oocsi/reference/nl/tue/id/oocsi/client/socket/package-frame.html
index 4ff5b63..6786bba 100644
--- a/dist/oocsi/reference/nl/tue/id/oocsi/client/socket/package-frame.html
+++ b/dist/oocsi/reference/nl/tue/id/oocsi/client/socket/package-frame.html
@@ -2,9 +2,9 @@
-
+
nl.tue.id.oocsi.client.socket
-
+
diff --git a/dist/oocsi/reference/nl/tue/id/oocsi/client/socket/package-summary.html b/dist/oocsi/reference/nl/tue/id/oocsi/client/socket/package-summary.html
index fc60e80..982390b 100644
--- a/dist/oocsi/reference/nl/tue/id/oocsi/client/socket/package-summary.html
+++ b/dist/oocsi/reference/nl/tue/id/oocsi/client/socket/package-summary.html
@@ -2,9 +2,9 @@
-
+
nl.tue.id.oocsi.client.socket
-
+
diff --git a/dist/oocsi/reference/nl/tue/id/oocsi/client/socket/package-tree.html b/dist/oocsi/reference/nl/tue/id/oocsi/client/socket/package-tree.html
index ab92930..3690061 100644
--- a/dist/oocsi/reference/nl/tue/id/oocsi/client/socket/package-tree.html
+++ b/dist/oocsi/reference/nl/tue/id/oocsi/client/socket/package-tree.html
@@ -2,9 +2,9 @@
-
+
nl.tue.id.oocsi.client.socket Class Hierarchy
-
+
diff --git a/dist/oocsi/reference/nl/tue/id/oocsi/package-frame.html b/dist/oocsi/reference/nl/tue/id/oocsi/package-frame.html
index e0983c8..72045aa 100644
--- a/dist/oocsi/reference/nl/tue/id/oocsi/package-frame.html
+++ b/dist/oocsi/reference/nl/tue/id/oocsi/package-frame.html
@@ -2,9 +2,9 @@
-
+
nl.tue.id.oocsi
-
+
diff --git a/dist/oocsi/reference/nl/tue/id/oocsi/package-summary.html b/dist/oocsi/reference/nl/tue/id/oocsi/package-summary.html
index 0b3844a..38b3b2c 100644
--- a/dist/oocsi/reference/nl/tue/id/oocsi/package-summary.html
+++ b/dist/oocsi/reference/nl/tue/id/oocsi/package-summary.html
@@ -2,9 +2,9 @@
-
+
nl.tue.id.oocsi
-
+
diff --git a/dist/oocsi/reference/nl/tue/id/oocsi/package-tree.html b/dist/oocsi/reference/nl/tue/id/oocsi/package-tree.html
index f836240..67422c3 100644
--- a/dist/oocsi/reference/nl/tue/id/oocsi/package-tree.html
+++ b/dist/oocsi/reference/nl/tue/id/oocsi/package-tree.html
@@ -2,9 +2,9 @@
-
+
nl.tue.id.oocsi Class Hierarchy
-
+
diff --git a/dist/oocsi/reference/overview-frame.html b/dist/oocsi/reference/overview-frame.html
index b7c6826..9873ea6 100644
--- a/dist/oocsi/reference/overview-frame.html
+++ b/dist/oocsi/reference/overview-frame.html
@@ -2,9 +2,9 @@
-
+
Overview List
-
+
diff --git a/dist/oocsi/reference/overview-summary.html b/dist/oocsi/reference/overview-summary.html
index 516b87d..65cf5b2 100644
--- a/dist/oocsi/reference/overview-summary.html
+++ b/dist/oocsi/reference/overview-summary.html
@@ -2,9 +2,9 @@
-
+
Overview
-
+
diff --git a/dist/oocsi/reference/overview-tree.html b/dist/oocsi/reference/overview-tree.html
index 3fcd9eb..5022ff8 100644
--- a/dist/oocsi/reference/overview-tree.html
+++ b/dist/oocsi/reference/overview-tree.html
@@ -2,9 +2,9 @@
-
+
Class Hierarchy
-
+
diff --git a/dist/oocsi/reference/serialized-form.html b/dist/oocsi/reference/serialized-form.html
index 8b10c3c..6688b87 100644
--- a/dist/oocsi/reference/serialized-form.html
+++ b/dist/oocsi/reference/serialized-form.html
@@ -2,9 +2,9 @@
-
+
Serialized Form
-
+
diff --git a/dist/oocsi/src/nl/tue/id/oocsi/OOCSI.java b/dist/oocsi/src/nl/tue/id/oocsi/OOCSI.java
index be5d9be..19ddb69 100644
--- a/dist/oocsi/src/nl/tue/id/oocsi/OOCSI.java
+++ b/dist/oocsi/src/nl/tue/id/oocsi/OOCSI.java
@@ -109,7 +109,7 @@ private OOCSI(Object parent, OOCSICommunicator communicator) {
}
/**
- * create a new OOCSI network connection with client handle (), server host, and port
+ * create a new OOCSI network connection with client handle ("name"), server host, and port
*
* @param parent
* @param name
@@ -221,6 +221,14 @@ public boolean isConnected() {
return oocsi.isConnected();
}
+ /**
+ * disconnect this client from the OOCSI network
+ *
+ */
+ public void disconnect() {
+ oocsi.disconnect();
+ }
+
/**
* send data through a channel given by the channelName
*
@@ -232,7 +240,7 @@ public OOCSIMessage channel(String channelName) {
}
/**
- * create a call for service method
+ * create a call for service method "callName"
*
* @param callName
* @return
@@ -242,7 +250,18 @@ public OOCSICall call(String callName) {
}
/**
- * create a call for service method
+ * create a call for service method "callName" on channel "channelName"
+ *
+ * @param channelName
+ * @param callName
+ * @return
+ */
+ public OOCSICall call(String channelName, String callName) {
+ return oocsi.call(channelName, callName);
+ }
+
+ /**
+ * create a call for service method "callName" with a specific timeout
*
* @param callName
* @param timeoutMS
@@ -253,7 +272,19 @@ public OOCSICall call(String callName, int timeoutMS) {
}
/**
- * create a call for service method
+ * create a call for service method "callName" with a specific timeout on channel "channelName"
+ *
+ * @param channelName
+ * @param callName
+ * @param timeoutMS
+ * @return
+ */
+ public OOCSICall call(String channelName, String callName, int timeoutMS) {
+ return oocsi.call(channelName, callName, timeoutMS);
+ }
+
+ /**
+ * create a call for service method "callName" with a specific timeout
*
* @param callName
* @param timeoutMS
@@ -264,6 +295,19 @@ public OOCSICall call(String callName, int timeoutMS, int maxResponses) {
return oocsi.call(callName, timeoutMS, maxResponses);
}
+ /**
+ * create a call for service method "callName" with a specific timeout on channel "channelName"
+ *
+ * @param channelName
+ * @param callName
+ * @param timeoutMS
+ * @param maxResponses
+ * @return
+ */
+ public OOCSICall call(String channelName, String callName, int timeoutMS, int maxResponses) {
+ return oocsi.call(channelName, callName, timeoutMS, maxResponses);
+ }
+
/**
* send raw data to given channel
*
@@ -289,7 +333,7 @@ public void subscribe(String channelName) {
}
/**
- * subscribe to a channel with a given handler method name
+ * subscribe to a channel with a given handler method name "handlerName"
*
* @param channelName
* @param handlerName
@@ -304,8 +348,8 @@ public void subscribe(String channelName, String handlerName) {
}
/**
- * subscribe to a channel with a given handler method name ; limits the rate of incoming events to
- * events per secs
+ * subscribe to a channel with a given handler method name "handlerName"; limits the rate of incoming events to
+ * "rate" events per "seconds" secs
*
* @param channelName
* @param handlerName
@@ -322,8 +366,8 @@ public void subscribe(String channelName, String handlerName, int rate, int seco
}
/**
- * subscribe to a channel with a given handler method name ; limits the rate of incoming events to
- * events per secs; controls whether we limit the rate of incoming event per sender
+ * subscribe to a channel with a given handler method name "handlerName"; limits the rate of incoming events to
+ * "rate" events per "seconds" secs; "ratePerSender" controls whether we limit the rate of incoming event per sender
* or for all events coming in from all senders
*
* @param channelName
@@ -356,7 +400,8 @@ public void register(String responderName) {
}
/**
- * register a responder; requires a method with the given responderName with parameters (OOCSIEvent, OOCSIData)
+ * register a responder "responderName"; requires a method with the given name "responderName" with parameters
+ * (OOCSIEvent, OOCSIData)
*
* @param responderName
* @param responderFunctionName
@@ -370,6 +415,39 @@ public void register(String responderName, String responderFunctionName) {
oocsi.register(responderName, responderFunctionName);
}
+ /**
+ * register a responder "responderName" on channel "channelName"; requires a method with the responder name
+ * "responderName" with parameters (OOCSIEvent, OOCSIData)
+ *
+ * @param channelName
+ * @param responderName
+ */
+ public void registerChannel(String channelName, String responderName) {
+
+ if (!oocsi.isConnected()) {
+ return;
+ }
+
+ oocsi.registerChannel(channelName, responderName);
+ }
+
+ /**
+ * register a responder "responderName" on channel "channelName"; requires a method with the given name
+ * "responderName" with parameters (OOCSIEvent, OOCSIData)
+ *
+ * @param channelName
+ * @param responderName
+ * @param responderFunctionName
+ */
+ public void registerChannel(String channelName, String responderName, String responderFunctionName) {
+
+ if (!oocsi.isConnected()) {
+ return;
+ }
+
+ oocsi.registerChannel(channelName, responderName, responderFunctionName);
+ }
+
/**
* retrieve the list of clients on the server
*
diff --git a/dist/oocsi/src/nl/tue/id/oocsi/OOCSIBoolean.java b/dist/oocsi/src/nl/tue/id/oocsi/OOCSIBoolean.java
index c258038..0b96b69 100644
--- a/dist/oocsi/src/nl/tue/id/oocsi/OOCSIBoolean.java
+++ b/dist/oocsi/src/nl/tue/id/oocsi/OOCSIBoolean.java
@@ -30,7 +30,7 @@ public OOCSIBoolean(boolean referenceValue, int timeout) {
}
/**
- * set the limiting of incoming events in terms of and timeframe; supports chained invocation
+ * set the limiting of incoming events in terms of "rate" and "seconds" timeframe; supports chained invocation
*
* @param rate
* @param seconds
diff --git a/dist/oocsi/src/nl/tue/id/oocsi/OOCSICommunicator.java b/dist/oocsi/src/nl/tue/id/oocsi/OOCSICommunicator.java
index 5185286..f6bd4c3 100644
--- a/dist/oocsi/src/nl/tue/id/oocsi/OOCSICommunicator.java
+++ b/dist/oocsi/src/nl/tue/id/oocsi/OOCSICommunicator.java
@@ -2,6 +2,7 @@
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
+import java.lang.reflect.Modifier;
import nl.tue.id.oocsi.client.OOCSIClient;
import nl.tue.id.oocsi.client.protocol.EventHandler;
@@ -86,7 +87,7 @@ public OOCSIMessage channel(String channelName) {
}
/**
- * create a call for service method
+ * create a call for service method "callName"
*
* @param callName
* @return
@@ -96,7 +97,18 @@ public OOCSICall call(String callName) {
}
/**
- * create a call for service method
+ * create a call for service method "callName" on channel "channelName"
+ *
+ * @param channelName
+ * @param callName
+ * @return
+ */
+ public OOCSICall call(String channelName, String callName) {
+ return call(channelName, callName, 1000, 1);
+ }
+
+ /**
+ * create a call for service method "callName" with a specific timeout
*
* @param callName
* @param timeoutMS
@@ -107,7 +119,19 @@ public OOCSICall call(String callName, int timeoutMS) {
}
/**
- * create a call for service method
+ * create a call for service method "callName" with a specific timeout on channel "channelName"
+ *
+ * @param channelName
+ * @param callName
+ * @param timeoutMS
+ * @return
+ */
+ public OOCSICall call(String channelName, String callName, int timeoutMS) {
+ return call(channelName, callName, timeoutMS, 1);
+ }
+
+ /**
+ * create a call for service method "callName" with a specific timeout
*
* @param callName
* @param timeoutMS
@@ -119,9 +143,22 @@ public OOCSICall call(String callName, int timeoutMS, int maxResponses) {
}
/**
- * subscribe to channel for handler method in the parent class; the handler method will
+ * create a call for service method "callName" with a specific timeout on channel "channelName"
+ *
+ * @param channelName
+ * @param callName
+ * @param timeoutMS
+ * @param maxResponses
+ * @return
+ */
+ public OOCSICall call(String channelName, String callName, int timeoutMS, int maxResponses) {
+ return new OOCSICall(this, channelName, callName, timeoutMS, maxResponses);
+ }
+
+ /**
+ * subscribe to channel "channelName" for handler method "channelName" in the parent class; the handler method will
* be called with an OOCSIEvent object upon occurrence of an event; will try 'handleOOCSIEvent' as a fall-back in
- * case no matching handler method is found for
+ * case no matching handler method is found for "channelName"
*
* @param channelName
* @return
@@ -131,7 +168,7 @@ public boolean subscribe(String channelName) {
}
/**
- * subscribe to channel for handler method in the parent class with the given name ; the
+ * subscribe to channel "channelName" for handler method in the parent class with the given name "handlerName"; the
* handler method will be called with an OOCSIEvent object upon occurrence of an event
*
* @param channelName
@@ -143,7 +180,7 @@ public boolean subscribe(String channelName, String handlerName) {
}
/**
- * subscribe to channel for handler method in the parent class with the given name ; the
+ * subscribe to channel "channelName" for handler method in the parent class with the given name "handlerName"; the
* handler method will be called with an OOCSIEvent object upon occurrence of an event
*
* @param channelName
@@ -157,7 +194,7 @@ public boolean subscribe(String channelName, String handlerName, int rate, int s
}
/**
- * subscribe to channel for handler method in the parent class with the given name ; the
+ * subscribe to channel "channelName" for handler method in the parent class with the given name "handlerName"; the
* handler method will be called with an OOCSIEvent object upon occurrence of an event
*
* @param channelName
@@ -167,12 +204,19 @@ public boolean subscribe(String channelName, String handlerName, int rate, int s
* @param ratePerSender
* @return
*/
- public boolean subscribe(String channelName, String handlerName, int rate, int seconds, boolean ratePerSender) {
+ public boolean subscribe(final String channelName, String handlerName, int rate, int seconds,
+ boolean ratePerSender) {
// try event handler with OOCSIEvent parameter
try {
final Method handler = parent.getClass().getDeclaredMethod(handlerName, new Class[] { OOCSIEvent.class });
+ if (!Modifier.isPublic(handler.getModifiers())) {
+ log(" - [ERROR] event handler for channel " + channelName
+ + " needs to be a public method: 'public void " + channelName + "(OOCSIEvent evt) { ... }'");
+ return false;
+ }
+
if (rate > 0 && seconds > 0) {
if (ratePerSender) {
subscribe(channelName, new RateLimitedClientEventHandler(rate, seconds) {
@@ -224,10 +268,13 @@ public void receive(OOCSIEvent event) {
}
});
}
+
log(" - subscribed to " + channelName + " with event handler");
return true;
- } catch (Exception e) {
+ } catch (
+
+ Exception e) {
// not found, just return false
if (!name.equals(channelName)) {
log(" - no event handler for channel " + channelName);
@@ -270,9 +317,9 @@ public void receive(OOCSIEvent event) {
}
/**
- * subscribe to channel for handler method in the parent class; the handler method
+ * subscribe to channel "responderName" for handler method "responderName" in the parent class; the handler method
* will be called with an OOCSIEvent object and a response map object upon occurrence of an event; will try
- * 'respondToOOCSIEvent' as a fall-back in case no matching handler method is found for
+ * 'respondToOOCSIEvent' as a fall-back in case no matching handler method is found for "responderName"
*
* @param responderName
* @return
@@ -282,7 +329,7 @@ public boolean register(String responderName) {
}
/**
- * register a handler method in the parent class with the given name for the channel ;
+ * register a handler method in the parent class with the given name "handlerName" for the channel "channelName";
* the handler method will be called with an OOCSIEvent object upon occurrence of an event
*
* @param responderName
@@ -327,4 +374,66 @@ public void respond(OOCSIEvent event, OOCSIData response) {
}
}
+
+ /**
+ * subscribe to channel "responderName" for handler method "responderName" in the parent class; the handler method
+ * will be called with an OOCSIEvent object and a response map object upon occurrence of an event; will try
+ * 'respondToOOCSIEvent' as a fall-back in case no matching handler method is found for "responderName"
+ *
+ * @param channelName
+ * @param responderName
+ * @return
+ */
+ public boolean registerChannel(String channelName, String responderName) {
+ return registerChannel(channelName, responderName, responderName) ? true
+ : registerChannel(channelName, responderName, "respondToOOCSIEvent");
+ }
+
+ /**
+ * register a handler method in the parent class with the given name "handlerName" for the channel "channelName";
+ * the handler method will be called with an OOCSIEvent object upon occurrence of an event
+ *
+ * @param channelName
+ * @param responderName
+ * @param handlerName
+ * @return
+ */
+ public boolean registerChannel(String channelName, String responderName, String handlerName) {
+
+ // try responder event handler with OOCSIEvent and response map parameters
+
+ try {
+ final Method handler = parent.getClass().getDeclaredMethod(handlerName,
+ new Class[] { OOCSIEvent.class, OOCSIData.class });
+ Responder responder = new Responder(this) {
+
+ @Override
+ public void respond(OOCSIEvent event, OOCSIData response) {
+ try {
+ handler.invoke(parent, new Object[] { event, response });
+ } catch (IllegalAccessException e) {
+ e.printStackTrace();
+ } catch (IllegalArgumentException e) {
+ e.printStackTrace();
+ } catch (InvocationTargetException e) {
+ e.printStackTrace();
+ }
+ }
+ };
+ responder.setCallName(responderName);
+ register(channelName, responderName, responder);
+
+ log(" - registered " + responderName + " as call responder");
+
+ return true;
+ } catch (Exception e) {
+ // not found, just return false
+ if (!name.equals(responderName)) {
+ log(" - no call responders found for channel " + responderName);
+ }
+
+ return false;
+ }
+
+ }
}
diff --git a/dist/oocsi/src/nl/tue/id/oocsi/OOCSIDouble.java b/dist/oocsi/src/nl/tue/id/oocsi/OOCSIDouble.java
index 4e2eb2e..70f7102 100644
--- a/dist/oocsi/src/nl/tue/id/oocsi/OOCSIDouble.java
+++ b/dist/oocsi/src/nl/tue/id/oocsi/OOCSIDouble.java
@@ -113,7 +113,7 @@ public OOCSIDouble timeout(int timeoutMS) {
}
/**
- * set the limiting of incoming events in terms of and timeframe; supports chained invocation
+ * set the limiting of incoming events in terms of "rate" and "seconds" timeframe; supports chained invocation
*
* @param rate
* @param seconds
@@ -188,7 +188,7 @@ public OOCSIDouble generator(long periodMS) {
/**
* creates a periodic feedback loop that feed either the last input value or the reference value into the variable
* (locally). If there is no reference value set, the former applies. The period is given in milliseconds. In
- * addition, the new value of the variable is sent out to the channel with the given key
+ * addition, the new value of the variable is sent out to the channel "outputChannel" with the given key "outputKey"
*
* @param periodMS
* @param outputChannel
diff --git a/dist/oocsi/src/nl/tue/id/oocsi/OOCSIFloat.java b/dist/oocsi/src/nl/tue/id/oocsi/OOCSIFloat.java
index 2502a3d..6cb673f 100644
--- a/dist/oocsi/src/nl/tue/id/oocsi/OOCSIFloat.java
+++ b/dist/oocsi/src/nl/tue/id/oocsi/OOCSIFloat.java
@@ -113,7 +113,7 @@ public OOCSIFloat timeout(int timeoutMS) {
}
/**
- * set the limiting of incoming events in terms of and timeframe; supports chained invocation
+ * set the limiting of incoming events in terms of "rate" and "seconds" timeframe; supports chained invocation
*
* @param rate
* @param seconds
@@ -189,7 +189,7 @@ public OOCSIFloat generator(long periodMS) {
/**
* creates a periodic feedback loop that feed either the last input value or the reference value into the variable
* (locally). If there is no reference value set, the former applies. The period is given in milliseconds. In
- * addition, the new value of the variable is sent out to the channel with the given key
+ * addition, the new value of the variable is sent out to the channel "outputChannel" with the given key "outputKey"
*
* @param periodMS
* @param outputChannel
diff --git a/dist/oocsi/src/nl/tue/id/oocsi/OOCSIInt.java b/dist/oocsi/src/nl/tue/id/oocsi/OOCSIInt.java
index 1a47f89..6118ae7 100644
--- a/dist/oocsi/src/nl/tue/id/oocsi/OOCSIInt.java
+++ b/dist/oocsi/src/nl/tue/id/oocsi/OOCSIInt.java
@@ -118,7 +118,7 @@ public OOCSIInt timeout(int timeoutMS) {
}
/**
- * set the limiting of incoming events in terms of and timeframe; supports chained invocation
+ * set the limiting of incoming events in terms of "rate" and "seconds" timeframe; supports chained invocation
*
* @param rate
* @param seconds
@@ -193,7 +193,7 @@ public OOCSIInt generator(long periodMS) {
/**
* creates a periodic feedback loop that feed either the last input value or the reference value into the variable
* (locally). If there is no reference value set, the former applies. The period is given in milliseconds. In
- * addition, the new value of the variable is sent out to the channel with the given key
+ * addition, the new value of the variable is sent out to the channel "outputChannel" with the given key "outputKey"
*
* @param periodMS
* @param outputChannel
diff --git a/dist/oocsi/src/nl/tue/id/oocsi/OOCSILong.java b/dist/oocsi/src/nl/tue/id/oocsi/OOCSILong.java
index efe6623..f534269 100644
--- a/dist/oocsi/src/nl/tue/id/oocsi/OOCSILong.java
+++ b/dist/oocsi/src/nl/tue/id/oocsi/OOCSILong.java
@@ -114,7 +114,7 @@ public OOCSILong timeout(int timeoutMS) {
}
/**
- * set the limiting of incoming events in terms of and timeframe; supports chained invocation
+ * set the limiting of incoming events in terms of "rate" and "seconds" timeframe; supports chained invocation
*
* @param rate
* @param seconds
@@ -189,7 +189,7 @@ public OOCSILong generator(long periodMS) {
/**
* creates a periodic feedback loop that feed either the last input value or the reference value into the variable
* (locally). If there is no reference value set, the former applies. The period is given in milliseconds. In
- * addition, the new value of the variable is sent out to the channel with the given key
+ * addition, the new value of the variable is sent out to the channel "outputChannel" with the given key "outputKey"
*
* @param periodMS
* @param outputChannel
diff --git a/dist/oocsi/src/nl/tue/id/oocsi/OOCSIString.java b/dist/oocsi/src/nl/tue/id/oocsi/OOCSIString.java
index de0f895..d0f68db 100644
--- a/dist/oocsi/src/nl/tue/id/oocsi/OOCSIString.java
+++ b/dist/oocsi/src/nl/tue/id/oocsi/OOCSIString.java
@@ -26,7 +26,7 @@ public OOCSIString(OOCSIClient client, String channelName, String key, String re
}
/**
- * set the limiting of incoming events in terms of and timeframe; supports chained invocation
+ * set the limiting of incoming events in terms of "rate" and "seconds" timeframe; supports chained invocation
*
* @param rate
* @param seconds
diff --git a/dist/oocsi/src/nl/tue/id/oocsi/client/OOCSIClient.java b/dist/oocsi/src/nl/tue/id/oocsi/client/OOCSIClient.java
index ee1e38a..bc7cde2 100644
--- a/dist/oocsi/src/nl/tue/id/oocsi/client/OOCSIClient.java
+++ b/dist/oocsi/src/nl/tue/id/oocsi/client/OOCSIClient.java
@@ -16,7 +16,7 @@
*/
public class OOCSIClient {
- public static final String VERSION = "1.3.6";
+ public static final String VERSION = "1.3.7";
private SocketClient sc;
protected String name;
@@ -46,8 +46,9 @@ public OOCSIClient(String name) {
// check oocsi name
if (name.contains(" ")) {
- log("OOCSI name cannot contain spaces");
- System.exit(-1);
+ log("[ERROR] OOCSI name cannot contain spaces");
+ log(" - OOCSI connection aborted");
+ return;
}
this.name = name;
@@ -172,7 +173,7 @@ public void register(OOCSICall call) {
}
/**
- * register a responder with the socket client with a given handle
+ * register a responder with the socket client with a given handle "callName"
*
* @param callName
* @param responder
@@ -183,6 +184,19 @@ public void register(String callName, Responder responder) {
sc.register(callName, responder);
}
+ /**
+ * register a responder with the socket client with a given handle "callName" on channel "channelName"
+ *
+ * @param channelName
+ * @param callName
+ * @param responder
+ */
+ public void register(String channelName, String callName, Responder responder) {
+ responder.setCallName(callName);
+ sc.subscribe(channelName, responder);
+ sc.register(callName, responder);
+ }
+
/**
* send a string message to the channel with the given name
*
diff --git a/dist/oocsi/src/nl/tue/id/oocsi/client/behavior/OOCSISpatial.java b/dist/oocsi/src/nl/tue/id/oocsi/client/behavior/OOCSISpatial.java
index d283c2f..7dc00d0 100644
--- a/dist/oocsi/src/nl/tue/id/oocsi/client/behavior/OOCSISpatial.java
+++ b/dist/oocsi/src/nl/tue/id/oocsi/client/behavior/OOCSISpatial.java
@@ -50,8 +50,7 @@ public class OOCSISpatial extends OOCSISystemCommunicator {
* @param client
* @param channelName
* @param key
- * @param myPosition
- * @param neighbourThreshold
+ * @param neighborDistance
*/
public OOCSISpatial(OOCSIClient client, String channelName, String key, Position neighborDistance) {
this(client, channelName, key, (int) (Math.random() * REBALANCING_TIMEOUT), null);
diff --git a/dist/oocsi/src/nl/tue/id/oocsi/client/data/OOCSIVariable.java b/dist/oocsi/src/nl/tue/id/oocsi/client/data/OOCSIVariable.java
index 3fe9c86..0bdf773 100644
--- a/dist/oocsi/src/nl/tue/id/oocsi/client/data/OOCSIVariable.java
+++ b/dist/oocsi/src/nl/tue/id/oocsi/client/data/OOCSIVariable.java
@@ -34,10 +34,10 @@ public class OOCSIVariable extends OOCSISystemCommunicator {
// key of internal variable in the OOCSI network
private String key;
- // reference or default value for variable in case nothing has been received for milliseconds
+ // reference or default value for variable in case nothing has been received for "timeout" milliseconds
private T internalReference;
- // amount of milliseconds to wait until the reference value is applied to
+ // amount of milliseconds to wait until the reference value is applied to "internalVariable"
private int timeout;
// last time the variable was updated
@@ -338,7 +338,7 @@ public OOCSIVariable timeout(int timeoutMS) {
}
/**
- * set the limiting of incoming events in terms of and timeframe; supports chained invocation
+ * set the limiting of incoming events in terms of "rate" and "seconds" timeframe; supports chained invocation
*
* @param rate
* @param seconds
@@ -379,7 +379,6 @@ public OOCSIVariable max(T max) {
* during operation, however, this will reset the buffer); supports chained invocation
*
* @param windowLength
- * @param sigma
* @return
*/
public OOCSIVariable smooth(int windowLength) {
@@ -417,7 +416,7 @@ public OOCSIVariable generator(long periodMS) {
/**
* creates a periodic feedback loop that feed either the last input value or the reference value into the variable
* (locally). If there is no reference value set, the former applies. The period is given in milliseconds. In
- * addition, the new value of the variable is sent out to the channel with the given key
+ * addition, the new value of the variable is sent out to the channel "outputChannel" with the given key "outputKey"
*
* @param periodMS
* @param outputChannel
diff --git a/dist/oocsi/src/nl/tue/id/oocsi/client/protocol/Handler.java b/dist/oocsi/src/nl/tue/id/oocsi/client/protocol/Handler.java
index de7359c..615efdb 100644
--- a/dist/oocsi/src/nl/tue/id/oocsi/client/protocol/Handler.java
+++ b/dist/oocsi/src/nl/tue/id/oocsi/client/protocol/Handler.java
@@ -51,7 +51,7 @@ abstract public void receive(String sender, Map data, long times
String recipient);
/**
- * parse the given String into a Map
+ * parse the given "data" String into a Map
*
* @param data
* @return
@@ -69,7 +69,7 @@ public static Map parseData(String data) throws IOException, Cla
}
/**
- * parse the given String into a long value
+ * parse the given "timestamp" String into a long value
*
* @param timestamp
* @return
diff --git a/dist/oocsi/src/nl/tue/id/oocsi/client/protocol/RateLimitedClientEventHandler.java b/dist/oocsi/src/nl/tue/id/oocsi/client/protocol/RateLimitedClientEventHandler.java
index 7ec5642..8434614 100644
--- a/dist/oocsi/src/nl/tue/id/oocsi/client/protocol/RateLimitedClientEventHandler.java
+++ b/dist/oocsi/src/nl/tue/id/oocsi/client/protocol/RateLimitedClientEventHandler.java
@@ -4,7 +4,7 @@
import java.util.Map;
/**
- * rate limited event handler for events with structured data that will only let through events per
+ * rate limited event handler for events with structured data that will only let through "rate" events per "second"
* secs; this counts for all incoming events per sender which protects against single senders overloading the system
*
* @author matsfunk
@@ -15,7 +15,7 @@ abstract public class RateLimitedClientEventHandler extends RateLimitedEventHand
private Map counter = new HashMap(100);
/**
- * creates a rate limited event handler that will at most let through event per secs
+ * creates a rate limited event handler that will at most let through "rate" event per "second" secs
*
* @param rate
* @param seconds
diff --git a/dist/oocsi/src/nl/tue/id/oocsi/client/protocol/RateLimitedEventHandler.java b/dist/oocsi/src/nl/tue/id/oocsi/client/protocol/RateLimitedEventHandler.java
index 76f4384..36d5889 100644
--- a/dist/oocsi/src/nl/tue/id/oocsi/client/protocol/RateLimitedEventHandler.java
+++ b/dist/oocsi/src/nl/tue/id/oocsi/client/protocol/RateLimitedEventHandler.java
@@ -3,7 +3,7 @@
import java.util.Map;
/**
- * rate limited event handler for events with structured data that will only let through events per
+ * rate limited event handler for events with structured data that will only let through "rate" events per "second"
* secs; this counts for all incoming events
*
* @author matsfunk
@@ -21,7 +21,7 @@ abstract public class RateLimitedEventHandler extends EventHandler {
private int counter = 0;
/**
- * creates a rate limited event handler that will at most let through event per secs
+ * creates a rate limited event handler that will at most let through "rate" event per "second" secs
*
* @param rate
* @param seconds
@@ -85,7 +85,7 @@ public void exceeded(String sender, Map data, long timestamp, St
}
/**
- * reconfigure the rate limitation to different and timeframe
+ * reconfigure the rate limitation to different "rate" and "seconds" timeframe
*
* @param rate
* @param seconds
diff --git a/dist/oocsi/src/nl/tue/id/oocsi/client/services/OOCSICall.java b/dist/oocsi/src/nl/tue/id/oocsi/client/services/OOCSICall.java
index 4958823..590339a 100644
--- a/dist/oocsi/src/nl/tue/id/oocsi/client/services/OOCSICall.java
+++ b/dist/oocsi/src/nl/tue/id/oocsi/client/services/OOCSICall.java
@@ -27,7 +27,7 @@ enum CALL_MODE {
private OOCSIEvent response = null;
/**
- * create a new message to the channel
+ * create a new message to the channel "channelName"
*
* @param oocsi
* @param callName
@@ -39,7 +39,7 @@ public OOCSICall(OOCSIClient oocsi, String callName, int timeoutMS, int maxRespo
}
/**
- * create a new message to the channel
+ * create a new message to the channel "channelName"
*
* @param oocsi
* @param channelName
diff --git a/dist/oocsi/src/nl/tue/id/oocsi/client/socket/SocketClient.java b/dist/oocsi/src/nl/tue/id/oocsi/client/socket/SocketClient.java
index ce79f7a..8fee43f 100644
--- a/dist/oocsi/src/nl/tue/id/oocsi/client/socket/SocketClient.java
+++ b/dist/oocsi/src/nl/tue/id/oocsi/client/socket/SocketClient.java
@@ -41,21 +41,28 @@ public class SocketClient {
private static final int MULTICAST_PORT = 4448;
private static final String MULTICAST_GROUP = "224.0.0.144";
+ private String hostname;
+ private int port;
private String name;
+
private Map channels;
private Map services;
private Queue tempIncomingMessages = new LinkedBlockingQueue(1);
private List openCalls = new LinkedList();
+ // i/o
private Socket socket;
private BufferedReader input;
private PrintWriter output;
+
+ // connection flags
private boolean disconnected = false;
private boolean hasPrintedServerInfo = false;
private boolean connectionEstablished = false;
private boolean reconnect = false;
private int reconnectCountDown = 100;
+ // thread pool
private ExecutorService executor;
/**
@@ -72,6 +79,11 @@ public SocketClient(String name, Map channels, Map 0)) {
- result = connectAttempt(hostname, port);
- if (result) {
- reconnectCountDown = 100;
- break;
- } else {
- sleep(1000);
- }
+
+ // store the connection details
+ this.hostname = hostname;
+ this.port = port;
+
+ // start connection thread
+ executor.submit(new SocketClientRunnable());
+
+ // check back on connection progress
+ while (!disconnected && !connectionEstablished && reconnectCountDown > 0) {
+ sleep(100);
}
- return result;
+ // return connection status
+ return connectionEstablished;
}
/**
@@ -164,8 +168,9 @@ public boolean connect(final String hostname, final int port) {
* @param hostname
* @param port
* @return
+ * @throws OOCSIAuthenticationException
*/
- private boolean connectAttempt(final String hostname, final int port) {
+ private boolean connectAttempt(final String hostname, final int port) throws OOCSIAuthenticationException {
try {
// configure and connect socket
connectSocket(hostname, port);
@@ -197,23 +202,35 @@ private boolean connectAttempt(final String hostname, final int port) {
}
/**
+ * connection handshake after the socket connection has been established
+ *
* @param hostname
* @param port
* @return
* @throws IOException
+ * @throws OOCSIAuthenticationException
*/
- private boolean connectionHandshake(final String hostname, final int port) throws IOException {
+ private boolean connectionHandshake(final String hostname, final int port)
+ throws IOException, OOCSIAuthenticationException {
+ // short timeout when connecting
+ socket.setSoTimeout(5000);
+
// check if we are ok to connect
String serverWelcomeMessage;
if (!socket.isClosed() && (serverWelcomeMessage = input.readLine()) != null) {
+ // name is not ok
if (!serverWelcomeMessage.startsWith("welcome")) {
disconnect();
log(" - disconnected (client name not accepted)");
- return false;
- } else {
- log(" - connected successfully");
+ throw new OOCSIAuthenticationException();
}
+ // name is ok
+ log(" - connected successfully");
+
+ // longer timeout after successful connection
+ socket.setSoTimeout(20000);
+
// first data has arrived = connection is ok
connectionEstablished = true;
@@ -222,16 +239,16 @@ private boolean connectionHandshake(final String hostname, final int port) throw
this.internalSubscribe(channelName);
}
- // if ok, run the communication in a different thread
- executor.submit(new SocketClientRunnable(hostname, port));
+ reconnectCountDown = 0;
+ return true;
}
reconnectCountDown = 0;
- return true;
+ return false;
}
/**
- * connect a socket
+ * configure and connect a socket
*
* @param hostname
* @param port
@@ -239,6 +256,8 @@ private boolean connectionHandshake(final String hostname, final int port) throw
* @throws IOException
*/
private void connectSocket(final String hostname, final int port) throws SocketException, IOException {
+
+ // open and configure socket
socket = new Socket();
socket.setTcpNoDelay(true);
socket.setTrafficClass(0x10);
@@ -251,6 +270,7 @@ private void connectSocket(final String hostname, final int port) throws SocketE
/**
* print server hint once
+ *
*/
private void printServerInfo() {
if (!hasPrintedServerInfo) {
@@ -289,8 +309,10 @@ public String getName() {
*
*/
public void disconnect() {
- // disconnect from server with handshake and no reconnect
+ // disconnect from server with handshake
disconnected = true;
+
+ // and no reconnect
reconnect = false;
reconnectCountDown = 0;
@@ -318,18 +340,17 @@ public void kill() {
*/
public void reconnect() {
output.println("quit");
-
internalDisconnect();
log(" - disconnected (by reconnect)");
}
/**
- * close all resources safely
+ * close all i/o resources safely
*
*/
private void internalDisconnect() {
- // shutdown IO
+ // shutdown I/O
try {
if (output != null) {
output.close();
@@ -341,9 +362,9 @@ private void internalDisconnect() {
socket.close();
}
} catch (IOException e) {
- e.printStackTrace();
+ // do nothing
} catch (NullPointerException e) {
- e.printStackTrace();
+ // do nothing
}
}
@@ -487,7 +508,7 @@ public void register(OOCSICall call) {
}
/**
- * register a responder with a handle
+ * register a responder with a handle "callName"
*
* @param callName
* @param responder
@@ -611,6 +632,19 @@ private String serialize(Map data) {
}
}
+ /**
+ * let thread sleep for ms milliseconds
+ *
+ */
+ private void sleep(int ms) {
+ try {
+ // so, wait a bit before next trial
+ Thread.sleep(ms);
+ } catch (InterruptedException e) {
+ // do nothing
+ }
+ }
+
/**
* logging of message on console (can be overridden by subclass)
*/
@@ -618,45 +652,85 @@ public void log(String message) {
// no logging by default
}
+ /**
+ * communication handler (to be run in a separate thread)
+ *
+ */
class SocketClientRunnable implements Runnable {
- private String hostname;
- private int port;
+ public SocketClientRunnable() {
+ // TODO Auto-generated constructor stub
+ }
- /**
- *
- *
- * @param hostname
- * @param port
- */
- public SocketClientRunnable(String hostname, int port) {
- this.hostname = hostname;
- this.port = port;
+ @Override
+ public void run() {
+ try {
+ int connections = 0;
+
+ // SESSIONS
+ // only do if we either always reconnect, or it's the first connection
+ while (reconnect || connections == 0) {
+ connections++;
+
+ // ATTEMPTS
+ // try 100 times per (re-)connection attempt
+ reconnectCountDown = 100;
+ while (reconnectCountDown-- > 0) {
+ // try to connect
+ if (connectAttempt(hostname, port)) {
+ // connection is fine, stop trials
+ break;
+ }
+
+ // another trial, sleep before
+ sleep(1000);
+ }
+
+ if (isConnected()) {
+ // connection rest forever
+ runCommunication();
+ } else {
+ // take a rest before trying again
+ sleep(5000);
+ }
+ }
+ } catch (OOCSIAuthenticationException oae) {
+ disconnect();
+ // quit this thread...
+ }
}
- /*
- * (non-Javadoc)
+ /**
+ * all communications after the initial handshake happen here
*
- * @see java.lang.Runnable#run()
*/
- public void run() {
+ private void runCommunication() {
try {
String fromServer;
- while (!socket.isClosed() && (fromServer = input.readLine()) != null) {
- handleMessage(fromServer);
- }
+ int cyclesSinceRead = 0;
+ while (!socket.isClosed()) {
- } catch (IOException e) {
- // do nothing
- } finally {
- internalDisconnect();
- log(" - OOCSI disconnected "
- + (!connectionEstablished ? "(client name not accepted)" : "(server unavailable)"));
+ // main messaging loop
+ while (input.ready() && (fromServer = input.readLine()) != null) {
+ handleMessage(fromServer);
+ cyclesSinceRead = 0;
+ }
- sleep(200);
+ // sleep if there is nothing to read
+ sleep(1);
- // try reconnect
- connect(hostname, port);
+ // if no data came in for 20 secs, kill connection and reconnect
+ if (cyclesSinceRead++ > 20000) {
+ internalDisconnect();
+ log(" - OOCSI disconnected (application level timeout)");
+ break;
+ }
+ }
+ } catch (Exception e) {
+ internalDisconnect();
+ if (connectionEstablished) {
+ log(" - OOCSI disconnected (server unavailable)");
+ }
}
}
@@ -702,15 +776,21 @@ public void handleMessage(String fromServer) throws IOException {
* @param c
*/
private void handleData(final String channel, final String data, final String timestamp, final String sender,
- Handler c) {
+ final Handler c) {
+ // try to parse the data
Map dataMap = parseData(data);
if (dataMap != null) {
handleMappedData(channel, data, timestamp, sender, c, dataMap);
}
+
// if dataMap not parseable and channel ready
else if (c != null) {
- c.send(sender, data, timestamp, channel, name);
+ executor.submit(new Runnable() {
+ public void run() {
+ c.send(sender, data, timestamp, channel, name);
+ }
+ });
}
}
@@ -725,7 +805,7 @@ else if (c != null) {
* @param dataMap
*/
private void handleMappedData(final String channel, final String data, final String timestamp,
- final String sender, Handler c, Map dataMap) {
+ final String sender, final Handler c, final Map dataMap) {
// try to find a responder
if (dataMap.containsKey(OOCSICall.MESSAGE_HANDLE)) {
final Responder r = services.get((String) dataMap.get(OOCSICall.MESSAGE_HANDLE));
@@ -736,7 +816,9 @@ public void run() {
r.receive(sender, Handler.parseData(data), Handler.parseTimestamp(timestamp), channel,
name);
} catch (ClassNotFoundException e) {
+ // nothing
} catch (Exception e) {
+ // nothing
}
}
});
@@ -750,11 +832,15 @@ public void run() {
// walk from back to allow for removal
for (int i = openCalls.size() - 1; i >= 0; i--) {
- OOCSICall call = openCalls.get(i);
+ final OOCSICall call = openCalls.get(i);
if (!call.isValid()) {
openCalls.remove(i);
} else if (call.getId().equals(id)) {
- call.respond(dataMap);
+ executor.submit(new Runnable() {
+ public void run() {
+ call.respond(dataMap);
+ }
+ });
break;
}
}
@@ -763,11 +849,18 @@ public void run() {
// if no responder or call and channel ready waiting
if (c != null) {
- c.send(sender, data, timestamp, channel, name);
+ executor.submit(new Runnable() {
+ public void run() {
+ c.send(sender, data, timestamp, channel, name);
+ }
+ });
}
+
}
/**
+ * parse the message data
+ *
* @param data
* @return
*/
@@ -783,4 +876,10 @@ private Map parseData(String data) {
return dataMap;
}
}
+
+ class OOCSIAuthenticationException extends Exception {
+
+ private static final long serialVersionUID = 5074228098705122200L;
+
+ }
}
diff --git a/src/nl/tue/id/oocsi/OOCSI.java b/src/nl/tue/id/oocsi/OOCSI.java
index be5d9be..19ddb69 100644
--- a/src/nl/tue/id/oocsi/OOCSI.java
+++ b/src/nl/tue/id/oocsi/OOCSI.java
@@ -109,7 +109,7 @@ private OOCSI(Object parent, OOCSICommunicator communicator) {
}
/**
- * create a new OOCSI network connection with client handle (), server host, and port
+ * create a new OOCSI network connection with client handle ("name"), server host, and port
*
* @param parent
* @param name
@@ -221,6 +221,14 @@ public boolean isConnected() {
return oocsi.isConnected();
}
+ /**
+ * disconnect this client from the OOCSI network
+ *
+ */
+ public void disconnect() {
+ oocsi.disconnect();
+ }
+
/**
* send data through a channel given by the channelName
*
@@ -232,7 +240,7 @@ public OOCSIMessage channel(String channelName) {
}
/**
- * create a call for service method
+ * create a call for service method "callName"
*
* @param callName
* @return
@@ -242,7 +250,18 @@ public OOCSICall call(String callName) {
}
/**
- * create a call for service method
+ * create a call for service method "callName" on channel "channelName"
+ *
+ * @param channelName
+ * @param callName
+ * @return
+ */
+ public OOCSICall call(String channelName, String callName) {
+ return oocsi.call(channelName, callName);
+ }
+
+ /**
+ * create a call for service method "callName" with a specific timeout
*
* @param callName
* @param timeoutMS
@@ -253,7 +272,19 @@ public OOCSICall call(String callName, int timeoutMS) {
}
/**
- * create a call for service method
+ * create a call for service method "callName" with a specific timeout on channel "channelName"
+ *
+ * @param channelName
+ * @param callName
+ * @param timeoutMS
+ * @return
+ */
+ public OOCSICall call(String channelName, String callName, int timeoutMS) {
+ return oocsi.call(channelName, callName, timeoutMS);
+ }
+
+ /**
+ * create a call for service method "callName" with a specific timeout
*
* @param callName
* @param timeoutMS
@@ -264,6 +295,19 @@ public OOCSICall call(String callName, int timeoutMS, int maxResponses) {
return oocsi.call(callName, timeoutMS, maxResponses);
}
+ /**
+ * create a call for service method "callName" with a specific timeout on channel "channelName"
+ *
+ * @param channelName
+ * @param callName
+ * @param timeoutMS
+ * @param maxResponses
+ * @return
+ */
+ public OOCSICall call(String channelName, String callName, int timeoutMS, int maxResponses) {
+ return oocsi.call(channelName, callName, timeoutMS, maxResponses);
+ }
+
/**
* send raw data to given channel
*
@@ -289,7 +333,7 @@ public void subscribe(String channelName) {
}
/**
- * subscribe to a channel with a given handler method name
+ * subscribe to a channel with a given handler method name "handlerName"
*
* @param channelName
* @param handlerName
@@ -304,8 +348,8 @@ public void subscribe(String channelName, String handlerName) {
}
/**
- * subscribe to a channel with a given handler method name ; limits the rate of incoming events to
- * events per secs
+ * subscribe to a channel with a given handler method name "handlerName"; limits the rate of incoming events to
+ * "rate" events per "seconds" secs
*
* @param channelName
* @param handlerName
@@ -322,8 +366,8 @@ public void subscribe(String channelName, String handlerName, int rate, int seco
}
/**
- * subscribe to a channel with a given handler method name ; limits the rate of incoming events to
- * events per secs; controls whether we limit the rate of incoming event per sender
+ * subscribe to a channel with a given handler method name "handlerName"; limits the rate of incoming events to
+ * "rate" events per "seconds" secs; "ratePerSender" controls whether we limit the rate of incoming event per sender
* or for all events coming in from all senders
*
* @param channelName
@@ -356,7 +400,8 @@ public void register(String responderName) {
}
/**
- * register a responder; requires a method with the given responderName with parameters (OOCSIEvent, OOCSIData)
+ * register a responder "responderName"; requires a method with the given name "responderName" with parameters
+ * (OOCSIEvent, OOCSIData)
*
* @param responderName
* @param responderFunctionName
@@ -370,6 +415,39 @@ public void register(String responderName, String responderFunctionName) {
oocsi.register(responderName, responderFunctionName);
}
+ /**
+ * register a responder "responderName" on channel "channelName"; requires a method with the responder name
+ * "responderName" with parameters (OOCSIEvent, OOCSIData)
+ *
+ * @param channelName
+ * @param responderName
+ */
+ public void registerChannel(String channelName, String responderName) {
+
+ if (!oocsi.isConnected()) {
+ return;
+ }
+
+ oocsi.registerChannel(channelName, responderName);
+ }
+
+ /**
+ * register a responder "responderName" on channel "channelName"; requires a method with the given name
+ * "responderName" with parameters (OOCSIEvent, OOCSIData)
+ *
+ * @param channelName
+ * @param responderName
+ * @param responderFunctionName
+ */
+ public void registerChannel(String channelName, String responderName, String responderFunctionName) {
+
+ if (!oocsi.isConnected()) {
+ return;
+ }
+
+ oocsi.registerChannel(channelName, responderName, responderFunctionName);
+ }
+
/**
* retrieve the list of clients on the server
*