OLA Client API - Revision history

Peternewman: Add link to doxygen tutorial

2013-10-12T10:40:46Z

Add link to doxygen tutorial

Nomis52: /* Example III: Sending multiple updates */

2013-04-20T02:53:58Z

‎Example III: Sending multiple updates

Nomis52: /* Example V: More complex client */

2013-02-25T03:30:26Z

‎Example V: More complex client

Nomis52 at 03:29, 25 February 2013

2013-02-25T03:29:12Z

Nomis52 at 03:20, 25 February 2013

2013-02-25T03:20:07Z

Nomis52 at 02:05, 25 February 2013

2013-02-25T02:05:31Z

Nomis52 at 20:24, 9 February 2013

2013-02-09T20:24:06Z

Nomis52: /* Example IV: Receiving DMX data */

2010-11-03T18:00:21Z

‎Example IV: Receiving DMX data

Nomis52: /* Example III: Sending multiple updates */

2010-11-03T17:53:38Z

‎Example III: Sending multiple updates

Nomis52: /* Example II: Sending an DMX update using the SimpleClient */

2010-11-03T17:48:31Z

‎Example II: Sending an DMX update using the SimpleClient

@@ Line 1: / Line 1: @@
   __TOC__
-'''Warning''': This documentation may be out of date. If in doubt check the code in the ola-examples package.
+'''Warning''': This documentation may be out of date. If in doubt check the code in the [http://docs.openlighting.org/doc/client_tutorial.html Doxygen documentation] or the ola-examples package.
 OLA provides a C++ client library which allows other applications to send/receive DMX as well as control the OLA server. When writing a client application, you have a choice between two client APIs. There was a third API, the OlaClient, but that was deprecated in Feb 2013. It will be removed in a future release and should not be used in new code.

@@ Line 182: / Line 182: @@
    #include <ola/OlaClient.h>
    #include <ola/OlaClientWrapper.h>
-   #include <ola/Closure.h>
+   #include <ola/Callback.h>
    // Maximum value of a dmx channel
@@ Line 193: / Line 193: @@
        DmxTimeout(ola::OlaClient *client): m_tick(0),
                                            m_client(client) {
-         buffer.Blackout();
+         m_buffer.Blackout();
          m_buffer.SetChannel(0, MAX_DMX);
+       }
@@ Line 199: / Line 199: @@
        // Called on timeout
        bool SendDmx() {
-         m_buffer.SetChannel(1, m_tick)
+         m_buffer.SetChannel(1, m_tick);
-         m_buffer.SetChannel(2, MAX_DMX - m_tick)
+         m_buffer.SetChannel(2, MAX_DMX - m_tick);
-         m_client->SendDmx(1, buffer);
+         m_client->SendDmx(1, m_buffer);
          m_tick++;
          m_tick %= MAX_DMX + 1;
@@ Line 222: / Line 222: @@
      // Create a timeout and register it
      DmxTimeout timeout(wrapper.GetClient());
-     ola::io::SelectServer ss = wrapper.GetSelectServer();
+     ola::io::SelectServer *ss = wrapper.GetSelectServer();
      ss->RegisterRepeatingTimeout(TIMEOUT_MS,
-                                  ola::NewClosure(&timeout, &DmxTimeout::SendDmx));
+                                  ola::NewCallback(&timeout, &DmxTimeout::SendDmx));
      // Start the main loop

@@ Line 277: / Line 277: @@
   #include <ola/network/Socket.h>
-  using ola::select_server::PipeSocket;
+  using ola::io::PipeSocket;
   int main() {

@@ Line 83: / Line 83: @@
      // Get the underlying SelectServer object
-     ola::network::SelectServer *ss = client->GetSelectServer();
+     ola::io::SelectServer *ss = client->GetSelectServer();
      // do stuff here
@@ Line 178: / Line 178: @@
    #include <ola/DmxBuffer.h>
-   #include <ola/network/SelectServer.h>
+   #include <ola/io/SelectServer.h>
    #include <ola/Logging.h>
    #include <ola/OlaClient.h>
@@ Line 222: / Line 222: @@
      // Create a timeout and register it
      DmxTimeout timeout(wrapper.GetClient());
-     ola::network::SelectServer ss = wrapper.GetSelectServer();
+     ola::io::SelectServer ss = wrapper.GetSelectServer();
      ss->RegisterRepeatingTimeout(TIMEOUT_MS,
                                   ola::NewClosure(&timeout, &DmxTimeout::SendDmx));
@@ Line 274: / Line 274: @@
   #include <ola/OlaClient.h>
-  #include <ola/select_server/SelectServer.h>
+  #include <ola/io/SelectServer.h>
-  #include <ola/select_server/Socket.h>
+  #include <ola/network/Socket.h>
   using ola::select_server::PipeSocket;
@@ Line 281: / Line 281: @@
   int main() {
     // Create the select server
-    ola::select_server::SelectServer ss;
+    ola::io::SelectServer ss;
     // Create the pipe socket to talk to the server on

@@ Line 240: / Line 240: @@
   #include <ola/Logging.h>
-  #include <ola/OlaCallbackClientWrapper.h>
+  #include <ola/OlaClientWrapper.h>
   static const unsigned int UNIVERSE = 1;

← Older revision		Revision as of 02:05, 25 February 2013
Line 4:		Line 4:

	OLA provides a C++ client library which allows other applications to send/receive DMX as well as control the OLA server. When writing a client application, you have a choice between two client APIs. There was a third API, the OlaClient, but that was deprecated in Feb 2013. It will be removed in a future release and should not be used in new code.		OLA provides a C++ client library which allows other applications to send/receive DMX as well as control the OLA server. When writing a client application, you have a choice between two client APIs. There was a third API, the OlaClient, but that was deprecated in Feb 2013. It will be removed in a future release and should not be used in new code.
		+
		+
		+	== Compiler & Linker Flags ==
		+
		+	To correctly build and link against libola you'll need to pass the right options to your build system. OLA installs a [http://en.wikipedia.org/wiki/Pkg-config pkg-config] file with the right flags. To get the flags run:
		+
		+	<pre>
		+	$ pkg-config --cflags --libs libola
		+	-I/usr/local/include -L/usr/local/lib -lola -lolacommon -lprotobuf
		+	</pre>
		+
		+	If you're using autotools, you can add
		+
		+	<pre>
		+	PKG_PROG_PKG_CONFIG
		+	PKG_CHECK_MODULES(libola, [libola >= 0.8.26])
		+	</pre>
		+
		+	to configure.ac

	== Different Client APIs ==		== Different Client APIs ==

@@ Line 3: / Line 3: @@
 '''Warning''': This documentation may be out of date. If in doubt check the code in the ola-examples package.
-OLA provides a C++ client library which allows other applications to send/receive DMX as well as control the OLA server. When writing a client application, you have a choice between three client APIs.
+OLA provides a C++ client library which allows other applications to send/receive DMX as well as control the OLA server. When writing a client application, you have a choice between two client APIs. There was a third API, the OlaClient, but that was deprecated in Feb 2013. It will be removed in a future release and should not be used in new code.
 == Different Client APIs ==
@@ Line 14: / Line 14: @@
 : Use the OlaCallbackClient which can be setup using the OlaCallbackClientWrapper
-; Do any of the following send DMX, receive DMX, patch ports, control RDM devices. ''Deprecated''
+=== OlaClient - DEPRECATED, DO NOT USE ===
 The OlaClient class provides a SetObserver() method which takes an object of type OlaClientObserver. When calls to the OlaClient object complete, the appropriate method is call on the OlaClientObserver object. The following diagrams attempts to show this (the red parts are the bit the client application provides).

@@ Line 223: / Line 223: @@
 ==Example IV: Receiving DMX data==
-The third example shows how to listen and respond to event from the LLA server.
+The forth example shows how to listen and respond to event from the OLA server.
   #include <ola/Logging.h>
-  #include <ola/SimpleClient.h>
+  #include <ola/OlaCallbackClientWrapper.h>
   static const unsigned int UNIVERSE = 1;
-  class OurObserver: public ola::OlaClientObserver {
+  void NewDmx(unsigned int universe,
-   public:
+             const DmxBuffer &data,
-     // Called when new DMX values arrive
+             const std::string &error) {
-     void NewDmx(unsigned int universe,
+   OLA_INFO << "Received " << (int) data.Size() <<
-                 const DmxBuffer &data,
+     " channels for universe " << (int) universe;
-                 const std::string &error) {
   int main() {
     ola::InitLogging(ola::OLA_LOG_INFO, ola::OLA_LOG_STDERR);
-    ola::SimpleClient simple_client;
+    ola::OlaCallbackClient wrapper;
-    if (!simple_client.Setup())
+    if (!wrapper.Setup())
       return -1;
     ola::OlaClient *client = simple_client.GetClient();
     // Set the observer and register our interest in this universe
-    client->SetObserver(&observer);
+    client->SetDmxCallback(UNIVERSE, NewCallback(&NewDmx));
     client->RegisterUniverse(UNIVERSE, ola::REGISTER);
     simple_client.GetSelectServer()->Run();
+  }
 ==Example V: More complex client==

@@ Line 133: / Line 133: @@
 ==Example II: Sending an DMX update using the SimpleClient==
-This example simply connects to the OLA Server and sends one DMX update just like the example above but using the SimpleClient.  It's about as basic as you can get because it requires no callbacks and exits immediately. We use two classes in this example, ''ola::SimpleClient'', and ''ola::OlaClient''.
+This example connects to the OLA Server and sends one DMX update just like the example above but instead uses OlaClient & OlaClientWrapper.  It's about as basic as you can get because it requires no callbacks and exits immediately.
   #include <ola/DmxBuffer.h>
   #include <ola/Logging.h>
-  #include <ola/SimpleClient.h>
+  #include <ola/OlaClientWrapper.h>
   int main() {
@@ Line 146: / Line 147: @@
     buffer.SetChannel(0, 255);
-    ola::SimpleClient simple_client;
+    ola::OlaClientWrapper wrapper;
-    if (!simple_client.Setup())
+    if (!wrapper.Setup())
       //setup failed
       return -1;
     // Get the underlying OlaClient object
-    ola::OlaClient *client = simple_client.GetClient();
+    ola::OlaClient *client = wrapper.GetClient();
     // Send the DMX data
     client->SendDmx(1, buffer);
+  }
 ==Example III: Sending multiple updates==