From 589e6c881bd2cf11e8615e9c1bf8cb4012293bad Mon Sep 17 00:00:00 2001 From: David Runge Date: Thu, 31 Dec 2015 03:34:08 +0100 Subject: libraries/oscP5: Adding oscP5 library for OSC capabilities. --- .../oscP5/reference/netP5/AbstractMulticast.html | 560 +++++++++++++++++++++ 1 file changed, 560 insertions(+) create mode 100644 libraries/oscP5/reference/netP5/AbstractMulticast.html (limited to 'libraries/oscP5/reference/netP5/AbstractMulticast.html') diff --git a/libraries/oscP5/reference/netP5/AbstractMulticast.html b/libraries/oscP5/reference/netP5/AbstractMulticast.html new file mode 100644 index 0000000..7de48fc --- /dev/null +++ b/libraries/oscP5/reference/netP5/AbstractMulticast.html @@ -0,0 +1,560 @@ + + + + + + +AbstractMulticast (Javadocs: oscP5) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +netP5 +
+Class AbstractMulticast

+
+java.lang.Object
+  extended by netP5.AbstractMulticast
+
+
+
All Implemented Interfaces:
Runnable
+
+
+
Direct Known Subclasses:
Multicast
+
+
+
+
public abstract class AbstractMulticast
extends Object
implements Runnable
+ + +

+

+ +

+ + + + + + + + + + + + + + +
+Constructor Summary
AbstractMulticast(UdpPacketListener theDatagramListener, + String theMulticastAddress, + int thePort) + +
+           
AbstractMulticast(UdpPacketListener theDatagramListener, + String theMulticastAddress, + int thePort, + int theBufferSize) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidclose() + +
+           
+ voiddispose() + +
+          dispose the multicastSocket.
+ booleanloopback() + +
+          get the current loopback mode.
+ voidrun() + +
+           
+ voidsend(byte[] theBytes) + +
+          send a byte array to the mulitcast address.
+ voidsend(String theString) + +
+          send a string to the multicast address.
+ voidsetDatagramSize(int theDatagramSize) + +
+          set the buffer size of the datagrams received by the multicast socket.
+ voidsetLoopback(boolean theFlag) + +
+          Disable/Enable local loopback of multicast datagrams.
+ booleansetTimeToLive(int theTTL) + +
+          Set the default time-to-live for multicast packets + sent out on this MulticastSocket in order to control the scope + of the multicasts.
+ MulticastSocketsocket() + +
+          get the running multicast socket.
+ voidstart() + +
+           
+ inttimeToLive() + +
+          get the current time to live value.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+AbstractMulticast

+
+public AbstractMulticast(UdpPacketListener theDatagramListener,
+                         String theMulticastAddress,
+                         int thePort,
+                         int theBufferSize)
+
+
+
Parameters:
theDatagramListener - UdpPacketListener
theMulticastAddress - String
thePort - int
theBufferSize - int
+
+
+ +

+AbstractMulticast

+
+public AbstractMulticast(UdpPacketListener theDatagramListener,
+                         String theMulticastAddress,
+                         int thePort)
+
+
+
Parameters:
theDatagramListener - UdpPacketListener
theMulticastAddress - String
thePort - int
+
+ + + + + + + + +
+Method Detail
+ +

+socket

+
+public MulticastSocket socket()
+
+
get the running multicast socket. +

+

+
+
+
+ +
Returns:
MulticastSocket
+
+
+
+ +

+setDatagramSize

+
+public void setDatagramSize(int theDatagramSize)
+
+
set the buffer size of the datagrams received by the multicast socket. +

+

+
+
+
+
Parameters:
theDatagramSize - int
+
+
+
+ +

+start

+
+public void start()
+
+
+
+
+
+
+
+
+
+ +

+run

+
+public void run()
+
+
+
Specified by:
run in interface Runnable
+
+
+
+
+
+
+ +

+dispose

+
+public void dispose()
+
+
dispose the multicastSocket. +

+

+
+
+
+
+
+
+
+ +

+close

+
+public void close()
+
+
+
+
+
+
+
+
+
+ +

+setTimeToLive

+
+public boolean setTimeToLive(int theTTL)
+
+
Set the default time-to-live for multicast packets + sent out on this MulticastSocket in order to control the scope + of the multicasts. theTTL must be in the range 0 <= ttl <= 255 +

+

+
+
+
+
Parameters:
theTTL - int +
Returns:
boolean
+
+
+
+ +

+timeToLive

+
+public int timeToLive()
+
+
get the current time to live value. +

+

+
+
+
+ +
Returns:
int
+
+
+
+ +

+setLoopback

+
+public void setLoopback(boolean theFlag)
+
+
Disable/Enable local loopback of multicast datagrams. + The option is used by the platform's networking code as a + hint for setting whether multicast data will be + looped back to the local socket. +

+

+
+
+
+
Parameters:
theFlag - boolean
+
+
+
+ +

+loopback

+
+public boolean loopback()
+
+
get the current loopback mode. messages loop back to the local address + if the loopback is set to false. set loopback to false to prevent messages + to loop back to your local address. +

+

+
+
+
+ +
Returns:
boolean
+
+
+
+ +

+send

+
+public void send(String theString)
+
+
send a string to the multicast address. +

+

+
+
+
+
Parameters:
theString - String
+
+
+
+ +

+send

+
+public void send(byte[] theBytes)
+
+
send a byte array to the mulitcast address. +

+

+
+
+
+
Parameters:
theBytes - byte[]
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+processing library oscP5 by Andreas Schlegel. (c) 2004-2012 + + -- cgit v1.2.3-70-g09d2