peer

Documentation

Index

• Variables
• type AccessPeeringState
• type CwtchPeer
  • func FromProfile(profile *model.Profile) CwtchPeer
  • func NewCwtchPeer(name string) CwtchPeer
• type ModifyContacts
• type ModifyContactsAndPeers
• type ModifyGroups
• type ModifyPeeringState
• type ModifyServers
• type ReadContacts
• type ReadGroups
• type ReadServers
• type SendMessages
• type SendMessagesToGroup

Variables

var DefaultEventsToHandle = []event.Type{
	event.EncryptedGroupMessage,
	event.NewMessageFromPeer,
	event.PeerAcknowledgement,
	event.NewGroupInvite,
	event.PeerError,
	event.SendMessageToGroupError,
	event.NewGetValMessageFromPeer,
	event.ProtocolEngineStopped,
	event.RetryServerRequest,
}

DefaultEventsToHandle specifies which events will be subscribed to

when a peer has its Init() function called

Types

type AccessPeeringState

type AccessPeeringState interface {
	GetPeerState(string) (connections.ConnectionState, bool)
}

AccessPeeringState provides access to functions relating to the underlying connections of a peer.

type CwtchPeer

type CwtchPeer interface {

	// Core Cwtch Peer Functions that should not be exposed to
	// most functions
	Init(event.Manager)
	AutoHandleEvents(events []event.Type)
	Listen()
	StartPeersConnections()
	StartServerConnections()
	Shutdown()

	// Relating to local attributes
	GetOnion() string
	SetAttribute(string, string)
	GetAttribute(string) (string, bool)

	ReadContacts
	ModifyContacts

	AccessPeeringState
	ModifyPeeringState

	ReadGroups
	ModifyGroups

	ReadServers
	ModifyServers

	SendMessages
	SendMessagesToGroup
}

CwtchPeer provides us with a way of testing systems built on top of cwtch without having to directly implement a cwtchPeer.

func FromProfile

func FromProfile(profile *model.Profile) CwtchPeer

FromProfile generates a new peer from a profile.

func NewCwtchPeer

func NewCwtchPeer(name string) CwtchPeer

NewCwtchPeer creates and returns a new cwtchPeer with the given name.

type ModifyContacts

type ModifyContacts interface {
	AddContact(nick, onion string, authorization model.Authorization)
	SetContactAuthorization(string, model.Authorization) error
	SetContactAttribute(string, string, string)
	DeleteContact(string)
}

ModifyContacts is a meta-interface intended to restrict callers to modify-only access to contacts

type ModifyContactsAndPeers

type ModifyContactsAndPeers interface {
	ReadContacts
	ModifyContacts
	ModifyPeeringState
}

ModifyContactsAndPeers is a meta-interface intended to restrict a call to reading and modifying contacts and peers.

type ModifyGroups

type ModifyGroups interface {
	ImportGroup(string) (string, error)
	StartGroup(string) (string, string, error)
	AcceptInvite(string) error
	RejectInvite(string)
	DeleteGroup(string)
	SetGroupAttribute(string, string, string)
}

ModifyGroups provides write-only access add/edit/remove new groups

type ModifyPeeringState

type ModifyPeeringState interface {
	BlockUnknownConnections()
	AllowUnknownConnections()
	PeerWithOnion(string)
	JoinServer(string) error
}

ModifyPeeringState is a meta-interface intended to restrict callers to modify-only access to connection peers

type ModifyServers

type ModifyServers interface {
	AddServer(string) error
}

ModifyServers provides write-only access to servers

type ReadContacts

type ReadContacts interface {
	GetContacts() []string
	GetContact(string) *model.PublicProfile
	GetContactAttribute(string, string) (string, bool)
}

ReadContacts is a meta-interface intended to restrict callers to read-only access to contacts

type ReadGroups

type ReadGroups interface {
	GetGroup(string) *model.Group
	GetGroupState(string) (connections.ConnectionState, bool)
	GetGroups() []string
	GetGroupAttribute(string, string) (string, bool)
	ExportGroup(string) (string, error)
}

ReadGroups provides read-only access to group state

type ReadServers

type ReadServers interface {
	GetServers() []string
}

ReadServers provides access to the servers

type SendMessages

type SendMessages interface {
	SendGetValToPeer(string, string, string)
	SendMessageToPeer(string, string) string

	// TODO This should probably not be exposed
	StoreMessage(onion string, messageTxt string, sent time.Time)

	// TODO Extract once groups are stable
	InviteOnionToGroup(string, string) error
}

SendMessages enables a caller to sender messages to a contact Note:

type SendMessagesToGroup

type SendMessagesToGroup interface {
	SendMessageToGroupTracked(string, string) (string, error)
}

SendMessagesToGroup enables a caller to sender messages to a group