portal

README

portal

Channels + messaging patterns = portals

Documentation

Index

• Variables
• func OptAsync(bufSize int) func(*portal)
• type Chan
• type Endpoint
• type Portal
  • func New(p Protocol, opts ...option) Portal
• type Protocol

Variables

var ErrChanClosed = errors.New("close of closed portal.Chan")

ErrChanClosed is thrown in a panic if a Chan is closed more than once

Functions

func OptAsync

func OptAsync(bufSize int) func(*portal)

OptAsync creates a buffered chan of the specified size

Types

type Chan

type Chan interface {
	Send() chan<- interface{}
	Recv() <-chan interface{}
	Close()
}

Chan is a two-way channel

type Endpoint

type Endpoint interface {
	Close()
	Done() <-chan struct{}
	Inbox() <-chan interface{}
	Outbox() chan<- interface{}
}

Endpoint represents the different IO channels that a Protocol must manage

type Portal

type Portal interface {
	Open() Chan
	Close()
}

Portal provides a thread-safe communication channel with messaging patterns.

func New

func New(p Protocol, opts ...option) Portal

New Portal

type Protocol

type Protocol interface {
	Close()
	AddEndpoint(Endpoint)
	RemoveEndpoint(Endpoint)
}

Protocol defines a messaging topology