ipc

Documentation

Overview

Package ipc contains types and functions used for interprocess communication between Seesaw components.

Index

• type AuthType
  • func (at AuthType) String() string
• type ConfigSource
• type Context
  • func NewAuthContext(component seesaw.Component, token string) *Context
  • func NewContext(component seesaw.Component) *Context
  • func NewTrustedContext(component seesaw.Component) *Context
  • func (ctx *Context) IsTrusted() bool
  • func (ctx *Context) String() string
• type HAState
• type HAStatus
• type Override
• type Peer

Types

type AuthType

type AuthType int

AuthType specifies the type of authentication established.

const (
	ATNone AuthType = iota
	ATSSO
	ATTrusted
	ATUntrusted
)

func (AuthType) String

func (at AuthType) String() string

String returns the string representation of an AuthType.

type ConfigSource

type ConfigSource struct {
	Ctx    *Context
	Source string
}

ConfigSource contains data for a config source IPC.

type Context

type Context struct {
	AuthToken string
	AuthType  AuthType
	Groups    []string
	Peer      Peer // Untrusted - client provided
	Proxy     Peer
	User      string
}

Context contains information relating to interprocess communication.

func NewAuthContext

func NewAuthContext(component seesaw.Component, token string) *Context

NewAuthContext returns a new authenticated context for the given component.

func NewContext

func NewContext(component seesaw.Component) *Context

NewContext returns a new context for the given component.

func NewTrustedContext

func NewTrustedContext(component seesaw.Component) *Context

NewTrustedContext returns a new trusted context for the given component.

func (*Context) IsTrusted

func (ctx *Context) IsTrusted() bool

IsTrusted returns whether a context came from a trusted source.

func (*Context) String

func (ctx *Context) String() string

String returns the string representation of a context.

type HAState

type HAState struct {
	Ctx   *Context
	State seesaw.HAState
}

HAState contains data for a HA state IPC.

type HAStatus

type HAStatus struct {
	Ctx    *Context
	Status seesaw.HAStatus
}

HAStatus contains data for a HA status IPC.

type Override

type Override struct {
	Ctx         *Context
	Vserver     *seesaw.VserverOverride
	Destination *seesaw.DestinationOverride
	Backend     *seesaw.BackendOverride
}

Override contains data for an override IPC.

type Peer

type Peer struct {
	Component seesaw.Component
	Identity  string
}

Peer contains information identifying a peer process.