types

Documentation

Overview

Package types implements all the types used by the Notifications protocol

Index

• type NotificationEvent
  • func NewNotificationEvent() *NotificationEvent
  • func (ne *NotificationEvent) Copy() types.RVType
  • func (ne *NotificationEvent) Equals(o types.RVType) bool
  • func (ne *NotificationEvent) ExtractFrom(readable types.Readable) error
  • func (ne *NotificationEvent) FormatToString(indentationLevel int) string
  • func (ne *NotificationEvent) String() string
  • func (ne *NotificationEvent) WriteTo(writable types.Writable)

Types

type NotificationEvent

type NotificationEvent struct {
	types.Structure
	PIDSource *types.PID
	Type      *types.PrimitiveU32
	Param1    *types.PrimitiveU32
	Param2    *types.PrimitiveU32
	StrParam  *types.String
	Param3    *types.PrimitiveU32
}

NotificationEvent is a type within the Notifications protocol

func NewNotificationEvent

func NewNotificationEvent() *NotificationEvent

NewNotificationEvent returns a new NotificationEvent

func (*NotificationEvent) Copy

func (ne *NotificationEvent) Copy() types.RVType

Copy returns a new copied instance of NotificationEvent

func (*NotificationEvent) Equals

func (ne *NotificationEvent) Equals(o types.RVType) bool

Equals checks if the given NotificationEvent contains the same data as the current NotificationEvent

func (*NotificationEvent) ExtractFrom

func (ne *NotificationEvent) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the NotificationEvent from the given readable

func (*NotificationEvent) FormatToString

func (ne *NotificationEvent) FormatToString(indentationLevel int) string

FormatToString pretty-prints the NotificationEvent using the provided indentation level

func (*NotificationEvent) String

func (ne *NotificationEvent) String() string

String returns the string representation of the NotificationEvent

func (*NotificationEvent) WriteTo

func (ne *NotificationEvent) WriteTo(writable types.Writable)

WriteTo writes the NotificationEvent to the given writable