channel

Documentation

Index

• Constants
• type AddressFormat
  • func (af AddressFormat) String() string
  • func (af *AddressFormat) UnmarshalText(b []byte) error
• type BindMap
• type ChannelType
  • func (ct ChannelType) String() string
  • func (ct *ChannelType) UnmarshalText(b []byte) error
• type Endpoint
  • func NewBoundIpcEndpoint(transport TransportType) Endpoint
  • func NewBoundTcpEndpoint(port uint64, transport TransportType) Endpoint
  • func NewIpcEndpoint(path string, transport TransportType) Endpoint
  • func NewTcpEndpoint(host string, port uint64, transport TransportType) Endpoint
• type Inbound
  • func MergeInbound(hp, lp []Inbound) (channels []Inbound)
  • func (inbound *Inbound) ToFMQMap(endpoint Endpoint) (pm controlcommands.PropertyMap)
  • func (inbound *Inbound) UnmarshalYAML(unmarshal func(interface{}) error) (err error)
• type IpcEndpoint
  • func (t IpcEndpoint) GetAddress() string
  • func (IpcEndpoint) GetAddressFormat() AddressFormat
  • func (t IpcEndpoint) GetTransport() TransportType
  • func (t IpcEndpoint) ToBoundEndpoint() Endpoint
  • func (t IpcEndpoint) ToTargetEndpoint(_ string) Endpoint
• type Outbound
  • func MergeOutbound(hp, lp []Outbound) (channels []Outbound)
  • func (outbound *Outbound) ToFMQMap(bindMap BindMap) (pm controlcommands.PropertyMap)
  • func (outbound *Outbound) UnmarshalYAML(unmarshal func(interface{}) error) (err error)
• type TcpEndpoint
  • func (t TcpEndpoint) GetAddress() string
  • func (TcpEndpoint) GetAddressFormat() AddressFormat
  • func (t TcpEndpoint) GetTransport() TransportType
  • func (t TcpEndpoint) ToBoundEndpoint() Endpoint
  • func (t TcpEndpoint) ToTargetEndpoint(taskHostname string) Endpoint
• type TransportType
  • func (tr TransportType) String() string
  • func (tr *TransportType) UnmarshalText(b []byte) error

Constants

const (
	PUSH = ChannelType("push")
	PULL = ChannelType("pull")
	PUB  = ChannelType("pub")
	SUB  = ChannelType("sub")
)

const (
	DEFAULT = TransportType("default")
	ZEROMQ  = TransportType("zeromq")
	NANOMSG = TransportType("nanomsg")
	SHMEM   = TransportType("shmem")
)

const (
	TCP = AddressFormat("tcp")
	IPC = AddressFormat("ipc")
)

Types

type AddressFormat

type AddressFormat string

func (AddressFormat) String

func (af AddressFormat) String() string

func (*AddressFormat) UnmarshalText

func (af *AddressFormat) UnmarshalText(b []byte) error

type BindMap

type BindMap map[string]Endpoint

type ChannelType

type ChannelType string

TODO: FairMQ has the following channel types: push/pull/pub/sub/spub/xsub/pair/req/rep/dealer/router Do we need to support them all?

func (ChannelType) String

func (ct ChannelType) String() string

func (*ChannelType) UnmarshalText

func (ct *ChannelType) UnmarshalText(b []byte) error

type Endpoint

type Endpoint interface {
	GetAddressFormat() AddressFormat
	GetAddress() string
	GetTransport() TransportType
	ToTargetEndpoint(taskHostname string) Endpoint
	ToBoundEndpoint() Endpoint
}

func NewBoundIpcEndpoint

func NewBoundIpcEndpoint(transport TransportType) Endpoint

func NewBoundTcpEndpoint

func NewBoundTcpEndpoint(port uint64, transport TransportType) Endpoint

func NewIpcEndpoint

func NewIpcEndpoint(path string, transport TransportType) Endpoint

func NewTcpEndpoint

func NewTcpEndpoint(host string, port uint64, transport TransportType) Endpoint

type Inbound

type Inbound struct {
	Addressing AddressFormat `yaml:"addressing"` //default: tcp
	// contains filtered or unexported fields
}

func MergeInbound

func MergeInbound(hp, lp []Inbound) (channels []Inbound)

func (*Inbound) ToFMQMap

func (inbound *Inbound) ToFMQMap(endpoint Endpoint) (pm controlcommands.PropertyMap)

func (*Inbound) UnmarshalYAML

func (inbound *Inbound) UnmarshalYAML(unmarshal func(interface{}) error) (err error)

type IpcEndpoint

type IpcEndpoint struct {
	Path      string
	Transport TransportType
}

func (IpcEndpoint) GetAddress

func (t IpcEndpoint) GetAddress() string

func (IpcEndpoint) GetAddressFormat

func (IpcEndpoint) GetAddressFormat() AddressFormat

func (IpcEndpoint) GetTransport

func (t IpcEndpoint) GetTransport() TransportType

func (IpcEndpoint) ToBoundEndpoint

func (t IpcEndpoint) ToBoundEndpoint() Endpoint

func (IpcEndpoint) ToTargetEndpoint

func (t IpcEndpoint) ToTargetEndpoint(_ string) Endpoint

type Outbound

type Outbound struct {
	Target string `json:"target" yaml:"target"`
	// contains filtered or unexported fields
}

func MergeOutbound

func MergeOutbound(hp, lp []Outbound) (channels []Outbound)

func (*Outbound) ToFMQMap

func (outbound *Outbound) ToFMQMap(bindMap BindMap) (pm controlcommands.PropertyMap)

func (*Outbound) UnmarshalYAML

func (outbound *Outbound) UnmarshalYAML(unmarshal func(interface{}) error) (err error)

type TcpEndpoint

type TcpEndpoint struct {
	Host      string
	Port      uint64
	Transport TransportType
}

func (TcpEndpoint) GetAddress

func (t TcpEndpoint) GetAddress() string

func (TcpEndpoint) GetAddressFormat

func (TcpEndpoint) GetAddressFormat() AddressFormat

func (TcpEndpoint) GetTransport

func (t TcpEndpoint) GetTransport() TransportType

func (TcpEndpoint) ToBoundEndpoint

func (t TcpEndpoint) ToBoundEndpoint() Endpoint

func (TcpEndpoint) ToTargetEndpoint

func (t TcpEndpoint) ToTargetEndpoint(taskHostname string) Endpoint

type TransportType

type TransportType string

func (TransportType) String

func (tr TransportType) String() string

func (*TransportType) UnmarshalText

func (tr *TransportType) UnmarshalText(b []byte) error