display

type CapabilityPayload struct {
	// Workspace namespace
	Namespace string
	// Workspace name
	Name string
}

type Capacity string

type Client struct {
	CapabilityEndpoint goa.Endpoint
	StatusEndpoint     goa.Endpoint
	JoinEndpoint       goa.Endpoint
	LeaveEndpoint      goa.Endpoint
	AcquireEndpoint    goa.Endpoint
	ReleaseEndpoint    goa.Endpoint
	TransferEndpoint   goa.Endpoint
}

type Conflict string

type DisplayCapability struct {
	// Whether shared display sessions are available for this workspace
	Enabled bool
	// Display protocol/API revision
	Protocol int
	// Supported display transports
	Transports []string
	// Maximum simultaneous participants (controller + observers)
	MaxParticipants *int
	// Maximum advertised guest framebuffer width
	MaxWidth *int
	// Maximum advertised guest framebuffer height
	MaxHeight *int
	// Display stream handshake timeout in milliseconds
	HandshakeTimeoutMs *int
	// Idle membership lifetime in milliseconds
	ParticipantTTLMs *int
	// Current participant count
	Participants *int
	// Whether a controller is currently attached
	ControllerPresent *bool
}

type DisplayControl struct {
	// Controller after the transition, if any
	Controller *Participant
	// Whether a controller was present before the transition
	WasHeld bool
	// True when release cleared the controller
	Released bool
}

type DisplayControlPayload struct {
	// Workspace namespace
	Namespace string
	// Workspace name
	Name string
	// Participant performing the transition. Release requires the current
	// controller; acquire may be any participant; transfer requires the current
	// controller
	ParticipantID string
	// Explicit human consent to take or transfer control, demoting the current
	// controller to observer. There is no silent takeover without this
	Force bool
	// Target observer participant identifier for a transfer
	To *string
}

type DisplayJoin struct {
	// The joined participant record
	Participant *Participant
	// Current capability state, including the live participant count
	Capability *DisplayCapability
}

type DisplayStatus struct {
	// Whether shared display sessions are available for this workspace
	Enabled bool
	// Display protocol/API revision
	Protocol int
	// Capture/broker generation. Changes when a new capture owner is elected
	Epoch string
	// Current controller, if any
	Controller *Participant
	// Current observers
	Observers []*Participant
	// Total participant count (controller + observers)
	Participants int
}

type Endpoints struct {
	Capability goa.Endpoint
	Status     goa.Endpoint
	Join       goa.Endpoint
	Leave      goa.Endpoint
	Acquire    goa.Endpoint
	Release    goa.Endpoint
	Transfer   goa.Endpoint
}

type Forbidden string

type Invalid string

type JoinDisplayPayload struct {
	// Workspace namespace
	Namespace string
	// Workspace name
	Name string
	// Initial role. Defaults to observer
	Role string
}

type LeaveDisplayPayload struct {
	// Workspace namespace
	Namespace string
	// Workspace name
	Name string
	// Participant identifier to remove
	ParticipantID string
}

type LeaveResult struct {
	// Whether the participant was removed
	OK bool
}

type NotFound string

type Participant struct {
	// Opaque server-side participant identifier. A capability, not a credential;
	// never sent to the guest or logged
	ID string
	// Current role: observer (view-only) or controller. Server-enforced; a
	// client-side viewOnly flag is not an authorization boundary
	Role string
	// Whether the participant is attached to a display stream
	Connected bool
	// RFC 3339 timestamp when the participant joined
	JoinedAt string
}

type Service interface {
	// Advertise whether a workspace participates in shared display sessions and
	// with which limits
	Capability(context.Context, *CapabilityPayload) (res *DisplayCapability, err error)
	// Report live membership and control state of a workspace's shared display
	// session
	Status(context.Context, *StatusPayload) (res *DisplayStatus, err error)
	// Join a workspace's shared display session as an observer or, when free, as
	// the controller
	Join(context.Context, *JoinDisplayPayload) (res *DisplayJoin, err error)
	// Leave a workspace's shared display session, releasing control when the
	// departing participant held it
	Leave(context.Context, *LeaveDisplayPayload) (res *LeaveResult, err error)
	// Acquire control of a workspace's shared display session, demoting the
	// current controller to observer when force is set
	Acquire(context.Context, *DisplayControlPayload) (res *DisplayControl, err error)
	// Release control of a workspace's shared display session, leaving observers
	// attached
	Release(context.Context, *DisplayControlPayload) (res *DisplayControl, err error)
	// Transfer control from the current controller to a named observer, keeping
	// all observers attached
	Transfer(context.Context, *DisplayControlPayload) (res *DisplayControl, err error)
}

type StatusPayload struct {
	// Workspace namespace
	Namespace string
	// Workspace name
	Name string
}

type Unauthorized string