mock

Documentation

Overview

Package mock provides an in-process, CGo-free implementation of the dds interfaces. All participants within the same process share a global in-memory broker: a Publisher.Write on topic T is delivered synchronously to every Subscriber.C() for topic T.

The mock is the default implementation used by unit tests. Switch to the rtps or cyclone package when a real DDS domain (multi-process, multi-host) is required.

Index

• func New(domain dds.Domain, opts ...Option) (dds.Participant, error)
• func NewLoaningPublisher(p dds.Participant, topic string, qos dds.QoS, bufSize int) (dds.LoaningPublisher, error)
• type Option
  • func IsolatedBroker() Option
  • func WithContext(ctx context.Context) Option
  • func WithDeadlineCallback(fn func(topic string)) Option
  • func WithLivelinessCallback(fn func(dds.GUID, dds.LivelinessEvent)) Option
  • func WithLogger(l *slog.Logger) Option

Functions

func New

func New(domain dds.Domain, opts ...Option) (dds.Participant, error)

New creates a mock DDS Participant for the given domain. Domain is accepted for API compatibility but has no effect — all mock participants share the same global broker regardless of domain (unless IsolatedBroker is used).

func NewLoaningPublisher

func NewLoaningPublisher(p dds.Participant, topic string, qos dds.QoS, bufSize int) (dds.LoaningPublisher, error)

NewLoaningPublisher creates a LoaningPublisher for topic using the given QoS. bufSize is the maximum sample size the pool will pre-allocate; pass 0 for the pool default (4096 bytes).

Types

type Option

type Option func(*participant)

Option configures a mock participant.

func IsolatedBroker

func IsolatedBroker() Option

IsolatedBroker creates the participant with its own independent broker that is not shared with any other participant. Use this when testing components that bridge between separate DDS domains (e.g. the WAN bridge), where publishing on one participant must not echo to subscribers on another.

func WithContext

func WithContext(ctx context.Context) Option

WithContext returns an Option that closes the participant when ctx is done. This is the idiomatic Go shutdown pattern: pass a context with a cancel function or deadline to tie the participant's lifetime to an outer scope.

func WithDeadlineCallback

func WithDeadlineCallback(fn func(topic string)) Option

WithDeadlineCallback registers fn to be called when a publisher has not written within its QoS.Deadline period.

func WithLivelinessCallback

func WithLivelinessCallback(fn func(dds.GUID, dds.LivelinessEvent)) Option

WithLivelinessCallback registers fn to be called when a participant is discovered or lost. In the mock, participants fire LivelinessGained on New and LivelinessLost on Close.

func WithLogger

func WithLogger(l *slog.Logger) Option

WithLogger sets the structured logger used by this participant. Log output is zero-cost when l is nil.