events.go

package gomavlib

import (
	"github.com/bluenviron/gomavlib/v4/pkg/frame"
	"github.com/bluenviron/gomavlib/v4/pkg/message"
)

// Event is the interface implemented by all events received with node.Events().
type Event interface {
	isEventOut()
}

// EventChannelOpen is fired when a channel is opened.
type EventChannelOpen struct {
	Channel *Channel
}

func (*EventChannelOpen) isEventOut() {}

// EventChannelClose is fired when a channel is closed.
type EventChannelClose struct {
	Channel *Channel
	Error   error
}

func (*EventChannelClose) isEventOut() {}

// EventFrame is fired when a frame is received.
type EventFrame struct {
	// frame
	Frame frame.Frame

	// channel from which the frame was received
	Channel *Channel
}

func (*EventFrame) isEventOut() {}

// SystemID returns the frame system id.
func (res *EventFrame) SystemID() byte {
	return res.Frame.GetSystemID()
}

// ComponentID returns the frame component id.
func (res *EventFrame) ComponentID() byte {
	return res.Frame.GetComponentID()
}

// Message returns the message inside the frame.
func (res *EventFrame) Message() message.Message {
	return res.Frame.GetMessage()
}

// EventParseError is fired when a parse error occurs.
type EventParseError struct {
	// error
	Error error

	// channel used to send the frame
	Channel *Channel
}

func (*EventParseError) isEventOut() {}

// EventStreamRequested is fired when an automatic stream request is sent.
type EventStreamRequested struct {
	// channel to which the stream request is addressed
	Channel *Channel

	// system id to which the stream requests is addressed
	SystemID byte

	// component id to which the stream requests is addressed
	ComponentID byte
}

func (*EventStreamRequested) isEventOut() {}