Documentation
¶
Index ¶
- Constants
- func Finalize() bool
- func GetLoadedConfigFilePath() string
- func GetVersion() C.struct_version
- func GetVersionDateString() string
- func GetVersionString() string
- func Initialize(config Config, unitName string, components uint) bool
- func IsComponentInitialized(component uint) bool
- func IsInitialized() bool
- func Ok() bool
- func PublisherShmEnabled() bool
- func PublisherTCPEnabled() bool
- func PublisherUDPEnabled() bool
- func SetState(severity ProcessSeverity, level ProcessSeverityLevel, state string)
- func ShutdownLocalEcalProcess(pid int)
- func SubscriberShmEnabled() bool
- func SubscriberTCPEnabled() bool
- func SubscriberUDPEnabled() bool
- type BinaryPublisher
- type BinarySubscriber
- type Config
- type ConfigOption
- type DataType
- type ProcessSeverity
- type ProcessSeverityLevel
- type ProtoMessage
- type ProtobufPublisher
- type ProtobufSubscriber
- type StringPublisher
- type StringSubscriber
Constants ¶
View Source
const ( // eCAL Components. CNone uint = 0x000 CPublisher uint = 0x001 CSubscriber uint = 0x002 CService uint = 0x004 CMonitoring uint = 0x008 CLogging uint = 0x010 CTimeSync uint = 0x020 CDefault uint = CPublisher | CSubscriber | CService | CLogging | CTimeSync CAll uint = CPublisher | CSubscriber | CService | CMonitoring | CLogging | CTimeSync )
Variables ¶
This section is empty.
Functions ¶
func GetLoadedConfigFilePath ¶
func GetLoadedConfigFilePath() string
func GetVersion ¶
func GetVersion() C.struct_version
func GetVersionDateString ¶
func GetVersionDateString() string
func GetVersionString ¶
func GetVersionString() string
func IsComponentInitialized ¶
func IsInitialized ¶
func IsInitialized() bool
func PublisherShmEnabled ¶
func PublisherShmEnabled() bool
func PublisherTCPEnabled ¶
func PublisherTCPEnabled() bool
func PublisherUDPEnabled ¶
func PublisherUDPEnabled() bool
func SetState ¶
func SetState(severity ProcessSeverity, level ProcessSeverityLevel, state string)
Set the processes state info.
func ShutdownLocalEcalProcess ¶
func ShutdownLocalEcalProcess(pid int)
Signals an event to a local process to cause eCAL::Ok() to return false.
func SubscriberShmEnabled ¶
func SubscriberShmEnabled() bool
func SubscriberTCPEnabled ¶
func SubscriberTCPEnabled() bool
func SubscriberUDPEnabled ¶
func SubscriberUDPEnabled() bool
Types ¶
type BinaryPublisher ¶
type BinaryPublisher = publisher.GenericPublisher[[]byte]
func NewBinaryPublisher ¶
func NewBinaryPublisher(topic string) (*BinaryPublisher, error)
type BinarySubscriber ¶
type BinarySubscriber = subscriber.GenericSubscriber[[]byte]
func NewBinarySubscriber ¶
func NewBinarySubscriber(topic string) (*BinarySubscriber, error)
type Config ¶
type Config struct {
// contains filtered or unexported fields
}
func NewConfig ¶
func NewConfig(opts ...ConfigOption) Config
type ConfigOption ¶
type ConfigOption func(*Config)
func WithConsoleLogAll ¶
func WithConsoleLogAll() ConfigOption
Enable all log levels when printing eCAL logs to stderr.
func WithConsoleLogging ¶
func WithConsoleLogging(enable bool) ConfigOption
Enable/Disable printing eCAL logs to stderr.
func WithUDPLogAll ¶
func WithUDPLogAll() ConfigOption
Enable all log levels when sending eCAL logs over UDP.
func WithUDPLogReceiving ¶
func WithUDPLogReceiving(enable bool) ConfigOption
func WithUDPLogging ¶
func WithUDPLogging(enable bool) ConfigOption
Enable/Disable sending eCAL logs over UDP.
type ProcessSeverity ¶
type ProcessSeverity uint8
const ( ProcSevUnknown ProcessSeverity = C.process_severity_unknown ProcSevHealthy ProcessSeverity = C.process_severity_healthy ProcSevWarning ProcessSeverity = C.process_severity_warning ProcSevCritical ProcessSeverity = C.process_severity_critical ProcSevFailed ProcessSeverity = C.process_severity_failed )
func (ProcessSeverity) String ¶
func (p ProcessSeverity) String() string
type ProcessSeverityLevel ¶
type ProcessSeverityLevel uint8
const ( ProcSevLevel1 ProcessSeverityLevel = 1 ProcSevLevel2 ProcessSeverityLevel = 2 ProcSevLevel3 ProcessSeverityLevel = 3 ProcSevLevel4 ProcessSeverityLevel = 4 ProcSevLevel5 ProcessSeverityLevel = 5 )
type ProtoMessage ¶
Type must be a pointer and implement the proto.Message interface.
type ProtobufPublisher ¶
type ProtobufPublisher[T proto.Message] = publisher.GenericPublisher[T]
func NewProtobufPublisher ¶
func NewProtobufPublisher[U any, T ProtoMessage[U]](topic string) (*ProtobufPublisher[T], error)
type ProtobufSubscriber ¶
type ProtobufSubscriber[T proto.Message] = subscriber.GenericSubscriber[T]
func NewProtobufSubscriber ¶
func NewProtobufSubscriber[U any, T ProtoMessage[U]](topic string) (*ProtobufSubscriber[T], error)
type StringPublisher ¶
type StringPublisher = publisher.GenericPublisher[string]
func NewStringPublisher ¶
func NewStringPublisher(topic string) (*StringPublisher, error)
type StringSubscriber ¶
type StringSubscriber = subscriber.GenericSubscriber[string]
func NewStringSubscriber ¶
func NewStringSubscriber(topic string) (*StringSubscriber, error)
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Implementation for cgo preamble functions
|
Implementation for cgo preamble functions |
|
Implementation for cgo preamble functions
|
Implementation for cgo preamble functions |
Click to show internal directories.
Click to hide internal directories.