Bus Messages 1.0
Bus Message Serialization Library
Loading...
Searching...
No Matches
bus Namespace Reference

Main namespace for the MDF library. More...

Classes

class  BusInterfaceFactory
 Factory class that create brokers/servers and clients. More...
class  BusLogStream
 Simple interface against a logging system. More...
class  CanDataFrame
 Implements an interface against a CAN Data Frame message. More...
struct  Channel
 The channel structure define a shared memory connection. More...
class  IBusMessage
 Abstract base class representing a generic bus message. More...
class  IBusMessageBroker
 Defines an interface to a broker, server or client. More...
class  IBusMessageQueue
 Interface against a message queue. More...
class  LittleBuffer
 Support class to handle byte order problems with numeric values. More...

Enumerations

enum class  BusLogSeverity : uint8_t {
  kTrace = 0 , kDebug = 1 , kInfo = 2 , kNotice = 3 ,
  kWarning = 4 , kError = 5 , kCritical = 6 , kAlert = 7 ,
  kEmergency = 8
}
 Defines the log severity level. More...
enum class  CanErrorType : uint8_t {
  UNKNOWN_ERROR = 0 , BIT_ERROR = 1 , FORM_ERROR = 2 , BIT_STUFFING_ERROR = 3 ,
  CRC_ERROR = 4 , ACK_ERROR = 5
}
 Enumerate yhat defines type of CAN bus error. More...
enum class  BusMessageType : uint16_t {
  Unknown = 0 , Ctrl_BusChannel = 1 , CAN_DataFrame = 10 , CAN_RemoteFrame = 11 ,
  CAN_ErrorFrame = 12 , CAN_OverloadFrame = 13
}
 Defines all message types.
enum class  BrokerType : int {
  SimulateBrokerType , SharedMemoryBrokerType , SharedMemoryServerType , SharedMemoryClientType ,
  TcpBrokerType , TcpServerType , TcpClientType
}
 Defines the types of brokers/servers and clients the factory interface can create. More...

Detailed Description

Main namespace for all Bus Message Library classes and functions.

Enumeration Type Documentation

◆ BrokerType

enum class bus::BrokerType : int
strong
Enumerator
SimulateBrokerType 

Only for internal test usage.

SharedMemoryBrokerType 

Shared memory broker.

SharedMemoryServerType 

Shared memory TX/RX server.

SharedMemoryClientType 

Shared memory TX/RX client.

TcpBrokerType 

Shared memory broker with a TCP/IP server.

TcpServerType 

TCP/IP TX/RX server.

TcpClientType 

TCP/IP TX/RX client.

◆ BusLogSeverity

enum class bus::BusLogSeverity : uint8_t
strong

Log severity level. Each log messaage havea severity attached. Note that the severity number/level is identical with the standard syslog severity.

Enumerator
kTrace 

Trace or listen message.

kDebug 

Debug message.

kInfo 

Informational message.

kNotice 

Notice message. Notify the user.

kWarning 

Warning message.

kError 

Error message.

kCritical 

Critical message (device error)

kAlert 

Alert or alarm message.

kEmergency 

Fatal error message.

◆ CanErrorType

enum class bus::CanErrorType : uint8_t
strong
Enumerator
UNKNOWN_ERROR 

Unspecified error.

BIT_ERROR 

CAN bit error.

FORM_ERROR 

CAN format error.

BIT_STUFFING_ERROR 

Bit stuffing error.

CRC_ERROR 

Checksum error.

ACK_ERROR 

Acknowledgement error.