Open Model Railroad Network (OpenMRN)
Loading...
Searching...
No Matches
If.hxx File Reference
#include <string>
#include "executor/Dispatcher.hxx"
#include "executor/Executor.hxx"
#include "executor/Service.hxx"
#include "openlcb/Convert.hxx"
#include "openlcb/Defs.hxx"
#include "openlcb/Node.hxx"
#include "utils/Buffer.hxx"
#include "utils/Map.hxx"
#include "utils/Queue.hxx"

Go to the source code of this file.

Classes

struct  openlcb::GenMessage
 This class is used in the dispatching of incoming or outgoing NMRAnet messages to the message handlers at the protocol-agnostic level (i.e. More...
 
class  openlcb::If
 Abstract class representing an OpenLCB Interface. More...
 
class  openlcb::IncomingMessageStateFlow
 Base class for incoming message handler flows. More...
 

Namespaces

namespace  openlcb
 

Typedefs

typedef FlowInterface< Buffer< GenMessage > > openlcb::MessageHandler
 Interface class for all handlers that can be registered in the dispatcher to receive incoming NMRAnet messages.
 
typedef StateFlow< Buffer< GenMessage >, QList< 4 > > openlcb::MessageStateFlowBase
 Message handlers that are implemented as state flows should derive from this class.
 

Functions

void openlcb::send_event (Node *src_node, uint64_t event_id)
 Helper function to send an event report to the bus.
 
template<typename... Args>
void openlcb::send_message (Node *src_node, Defs::MTI mti, Args &&...args)
 Sends an OpenLCB message to the bus.
 

Detailed Description

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Asynchronous NMRAnet interface.

Author
Balazs Racz
Date
3 Dec 2013

Definition in file If.hxx.