OLA developer info - Revision history

Peternewman: /* Plugin System */ Fix the link

2017-12-31T12:55:11Z

‎Plugin System: Fix the link

Peternewman: Wikipedia Interwiki links

2014-08-30T14:00:54Z

Wikipedia Interwiki links

Peternewman: Change to GitHub links

2014-08-30T13:58:55Z

Change to GitHub links

Show changes

Peternewman: /* A Brief Tour */ Convert to GitHub

2014-08-30T13:48:52Z

‎A Brief Tour: Convert to GitHub

Peternewman: /* Plugin System */ OSC walkthrough

2013-11-28T14:00:10Z

‎Plugin System: OSC walkthrough

Nomis52: /* Random Numbers */

2013-03-16T16:09:31Z

‎Random Numbers

Nomis52: /* HTTP Server */

2013-03-11T02:38:14Z

‎HTTP Server

Nomis52: /* Threads and Locking */

2013-03-10T02:24:12Z

‎Threads and Locking

Nomis52 at 02:23, 10 March 2013

2013-03-10T02:23:04Z

Nomis52: /* RPC Mechanism */

2013-03-10T02:20:54Z

‎RPC Mechanism

@@ Line 479: / Line 479: @@
 == Plugin System ==
-Read a walkthrough of the OSC plugin [[code:plugins/osc/README|here]].
+Read a walkthrough of the OSC plugin [[code:plugins/osc/README.developer.md|here]].
 We'll use plugin to refer to the entire module (Plugin, Devices & Ports), and Plugin to refer to the class that inherits from Plugin.

@@ Line 147: / Line 147: @@
 IOQueues are nice because they grow as data is written. Normally you don't write to IOQueues directly but instead use an OutputStream.
-IOQueues are also integrated with the Socket classes, so they avoid a memory copy. For instance when you call UDPSocket::SendTo() it uses [http://en.wikipedia.org/wiki/Vectored_I/O Vector I/O] to avoid a copy.
+IOQueues are also integrated with the Socket classes, so they avoid a memory copy. For instance when you call UDPSocket::SendTo() it uses [[wp:Vectored_I/O|Vector I/O]] to avoid a copy.
 ==== MemoryBuffer ====
@@ Line 375: / Line 375: @@
 <tt>[[code:include/ola/thread/Thread.h|ola/include/thread/Mutex.h]]</tt>
-This provides [http://en.wikipedia.org/wiki/Mutual_exclusion Mutexes] (non-recursive) and [http://en.wikipedia.org/wiki/Monitor_(synchronization) Condition Variables] (Monitors).
+This provides [[wp:Mutual_exclusion|Mutexes]] (non-recursive) and [[wp:Monitor_(synchronization)|Condition Variables]] (Monitors).
 <pre>
@@ Line 426: / Line 426: @@
 <tt>include/ola/timecode/TimeEnums.h</tt>
-A simple class for handling [http://en.wikipedia.org/wiki/Timecode Timecode] data. See [[OLA_TimeCode | OLA Timecode]] for more info.
+A simple class for handling [[wp:Timecode|Timecode]] data. See [[OLA_TimeCode | OLA Timecode]] for more info.
 === JSON ===
 <tt>[[code:include/ola/web/Json.h|include/ola/web/Json.h]]</tt>
-A set of classes for constructing [http://en.wikipedia.org/wiki/JSON JSON] data structures and serializing them.
+A set of classes for constructing [[wp:JSON|JSON]] data structures and serializing them.
 <pre>

@@ Line 3: / Line 3: @@
 == A Brief Tour ==
-Let's quickly cover the layout, you can [http://code.google.com/p/open-lighting/source/browse/ browse the code online] to follow along.
+Let's quickly cover the layout, you can [[code:|browse the code online]] to follow along.
-: <tt>[http://code.google.com/p/open-lighting/source/browse/#git%2Finclude include]</tt> - contains the header files (.h) that are installed on the system
+: <tt>[[code:include|include]]</tt> - contains the header files (.h) that are installed on the system
-:: <tt>[http://code.google.com/p/open-lighting/source/browse/#git%2Finclude%2Fola%253Fstate%253Dclosed ola]</tt> - headers for the OLA framework. If the header is used by both the client and server code it belongs here
+:: <tt>[[code:include/ola|ola]]</tt> - headers for the OLA framework. If the header is used by both the client and server code it belongs here
-:: <tt>[http://code.google.com/p/open-lighting/source/browse/#git%2Finclude%2Folad olad]</tt> - headers specifically for the olad server
+:: <tt>[[code:include/olad|olad]]</tt> - headers specifically for the olad server
-: <tt>[http://code.google.com/p/open-lighting/source/browse/#git%2Fcommon common]</tt> - code for the ola framework, contains the implementations of everything in include/ola/
+: <tt>[[code:common|common]]</tt> - code for the ola framework, contains the implementations of everything in include/ola/
-: <tt>[http://code.google.com/p/open-lighting/source/browse/#git%2Folad olad]</tt> - the olad server code
+: <tt>[[code:olad|olad]]</tt> - the olad server code
-: <tt>[http://code.google.com/p/open-lighting/source/browse/#git%2Fola ola]</tt> - the ola C++ client code
+: <tt>[[code:ola|ola]]</tt> - the ola C++ client code
-: <tt>[http://code.google.com/p/open-lighting/source/browse/#git%2Fplugins plugins]</tt> - headers and code for all the olad plugins
+: <tt>[[code:plugins|plugins]]</tt> - headers and code for all the olad plugins
-: <tt>[http://code.google.com/p/open-lighting/source/browse/#git%2Fjavascript javascript]</tt> - the client side code used for the web UI
+: <tt>[[code:javascript|javascript]]</tt> - the client side code used for the web UI
-: <tt>[http://code.google.com/p/open-lighting/source/browse/#git%2Fjava java]</tt> - the Java OLA client
+: <tt>[[code:java|java]]</tt> - the Java OLA client
-: <tt>[http://code.google.com/p/open-lighting/source/browse/#git%2Fpython python]</tt> - the Python OLA client
+: <tt>[[code:python|python]]</tt> - the Python OLA client
-: <tt>[http://code.google.com/p/open-lighting/source/browse/#git%2Ftools tools]</tt> - Various utilities like the RDM sniffer, the [[RDM_Responder_Testing | RDM Responder Tests]], [[OLA_DMX_Trigger | DMX Trigger]] etc.
+: <tt>[[code:tools|tools]]</tt> - Various utilities like the RDM sniffer, the [[RDM_Responder_Testing | RDM Responder Tests]], [[OLA_DMX_Trigger | DMX Trigger]] etc.
 <tt>include/ola</tt> is further broken into modules. There are modules for RDM (<tt>include/ola/rdm</tt>), HTTP (<tt>include/ola</tt>), IO, Network etc.

← Older revision		Revision as of 14:00, 28 November 2013
Line 479:		Line 479:

	== Plugin System ==		== Plugin System ==
		+	Read a walkthrough of the OSC plugin [https://code.google.com/p/open-lighting/source/browse/plugins/osc/README here].

	We'll use plugin to refer to the entire module (Plugin, Devices & Ports), and Plugin to refer to the class that inherits from Plugin.		We'll use plugin to refer to the entire module (Plugin, Devices & Ports), and Plugin to refer to the class that inherits from Plugin.

@@ Line 315: / Line 315: @@
 InitRandom();
 int r = Random(1, 10);  // returns an int in the range 1 .. 10
 </pre>

@@ Line 453: / Line 453: @@
 === HTTP Server ===
-olad/OlaHttpServer.h implements the OLA specific behavior.
+olad/OlaHttpServer.h implements the OLA specific behavior and runs as a separate thread. This uses the OlaCallbackClient which has a TCP connection open to the OLAD core, just like any normal client.
-−
 == Plugin System ==

← Older revision		Revision as of 02:24, 10 March 2013
Line 395:		Line 395:

	It saves a line of code, and unlocks the Mutex automatically when it goes out of scope.		It saves a line of code, and unlocks the Mutex automatically when it goes out of scope.
		+
		+
		+	=== RDM ===
		+
		+	Write me.

	=== Timecode ===		=== Timecode ===

@@ Line 242: / Line 242: @@
 AppInit(argc, argv);
 </pre>
 === Logging ===
@@ Line 440: / Line 446: @@
 On the server side, OLAD creates a listening socket and then calls [http://code.google.com/p/open-lighting/source/browse/olad/OlaServer.cpp#427 InternalNewConnection] each time a client connects. This sets up a OlaClientService object, which is what gets called when a new message is received. The OlaClientService objects call into [http://code.google.com/p/open-lighting/source/browse/olad/OlaServerServiceImpl.cpp OlaServerServiceImpl.cpp] which is where the message handling takes place.
 == Plugin System ==
@@ Line 551: / Line 561: @@
 The example program constructs configuration request messages and sends them (using LlaClient) to the Lla Core. The core routes this message to the plugin, which then returns a response message. This response is passed back to the client.
 == Ideas for easy configuration ==

← Older revision		Revision as of 02:20, 10 March 2013
Line 551:		Line 551:

	The example program constructs configuration request messages and sends them (using LlaClient) to the Lla Core. The core routes this message to the plugin, which then returns a response message. This response is passed back to the client.		The example program constructs configuration request messages and sends them (using LlaClient) to the Lla Core. The core routes this message to the plugin, which then returns a response message. This response is passed back to the client.
−
−	~~== RPC Mechanism ==~~
−
−	RPCs are at the heart of OLA. The RPC system is built on [http://code.google.com/apis/protocolbuffers/ protocol buffers]. olad/OlaServerServiceImpl.h provides the implementation for the RPCs on the server side.

	== HTTP Server ==		== HTTP Server ==