internal

Documentation

Overview

Package internal segments off things that must be public for serialization but have no place in the main documentation.

Some types are replicated as they can't be imported from the main reign package due to circular imports.

Index

• type AllNodeClaims
• type ClusterHandshake
• type ClusterMessage
• type DestroyConnection
• type IncomingMailboxMessage
• type IntMailboxID
  • func (mID IntMailboxID) NodeID() IntNodeID
• type IntNodeID
• type NotifyNodeOnTerminate
• type NotifyRemote
• type OutgoingMailboxMessage
• type PanicHandler
• type Ping
• type Pong
• type RegisterName
• type RegisterRemoteNode
• type RegistryMailbox
• type RemoteMailboxClosed
• type RemoveNotifyNodeOnClose
• type UnnotifyRemote
• type UnregisterMailbox
• type UnregisterName

Types

type AllNodeClaims

type AllNodeClaims struct {
	Node   IntNodeID
	Claims map[string]map[IntMailboxID]struct{}
}

AllNodeClaims is part of the internal registry's private communication.

type ClusterHandshake

type ClusterHandshake struct {
	ClusterVersion uint16
	MyNodeID       IntNodeID
	YourNodeID     IntNodeID
}

ClusterHandshake is part of the cluster connection process. This type is sent directly. Therefore, it does not need to implement the ClusterMessage interface, nor be registered with gob.

type ClusterMessage

type ClusterMessage interface {
	// contains filtered or unexported methods
}

ClusterMessage is a tag used to identify messages the cluster can send across the wire.

type DestroyConnection

type DestroyConnection struct{}

DestroyConnection is used internally to simulate connection loss.

type IncomingMailboxMessage

type IncomingMailboxMessage struct {
	Target  IntMailboxID
	Message interface{}
}

IncomingMailboxMessage indicates the embedded message is destined for a local mailbox.

type IntMailboxID

type IntMailboxID uint64

IntMailboxID reflects the internal mailboxID type.

func (IntMailboxID) NodeID

func (mID IntMailboxID) NodeID() IntNodeID

NodeID returns the node ID corresponding to the current mailbox ID.

type IntNodeID

type IntNodeID byte

IntNodeID reflects the NodeID type in the main package.

type NotifyNodeOnTerminate

type NotifyNodeOnTerminate struct {
	IntMailboxID
}

NotifyNodeOnTerminate is an internal message, public only for gob's sake.

type NotifyRemote

type NotifyRemote struct {
	Local  IntMailboxID
	Remote IntMailboxID
}

NotifyRemote is an internal message, public only for gob's sake.

type OutgoingMailboxMessage

type OutgoingMailboxMessage struct {
	Target  IntMailboxID
	Message interface{}
}

OutgoingMailboxMessage indicates that this wraps an outgoing message.

type PanicHandler

type PanicHandler struct{}

PanicHandler can be sent over the network to cause the receiver to panic, simulating whatever may end up doing that.

type Ping

type Ping struct{}

Ping is sent in order to keep the network connection open.

type Pong

type Pong struct{}

Pong is sent in reply to a Ping message. When received, the connection deadline is progressed.

type RegisterName

type RegisterName struct {
	Node      IntNodeID
	Name      string
	MailboxID IntMailboxID
}

RegisterName is part of the internal registry's private communication.

type RegisterRemoteNode

type RegisterRemoteNode struct {
	Node      IntNodeID
	MailboxID IntMailboxID
}

RegisterRemoteNode is part of the internal registry's private communication.

type RegistryMailbox

type RegistryMailbox struct {
	Node      IntNodeID
	MailboxID IntMailboxID
}

RegistryMailbox is sent between node registries to populate their nodeRegistries map.

type RemoteMailboxClosed

type RemoteMailboxClosed struct {
	IntMailboxID
}

RemoteMailboxClosed is an internal message, public only for gob's sake.

type RemoveNotifyNodeOnClose

type RemoveNotifyNodeOnClose struct {
	IntMailboxID
}

RemoveNotifyNodeOnClose is an internal message, public only for gob's sake.

type UnnotifyRemote

type UnnotifyRemote struct {
	Local  IntMailboxID
	Remote IntMailboxID
}

UnnotifyRemote is an internal message, public only for gob's sake.

type UnregisterMailbox

type UnregisterMailbox struct {
	Node      IntNodeID
	MailboxID IntMailboxID
}

UnregisterMailbox is part of the internal registry's private communication.

type UnregisterName

type UnregisterName struct {
	Node      IntNodeID
	Name      string
	MailboxID IntMailboxID
}

UnregisterName is part of the internal registry's private communication.