peer

Documentation

Index

• type CwtchPeer
  • func FromProfile(profile *model.Profile) CwtchPeer
  • func NewCwtchPeer(name string) CwtchPeer

Types

type CwtchPeer

type CwtchPeer interface {
	Init(event.Manager)
	AutoHandleEvents(events []event.Type)
	PeerWithOnion(string)
	InviteOnionToGroup(string, string) error
	SendMessageToPeer(string, string) string
	SendGetValToPeer(string, string, string)

	SetContactAuthorization(string, model.Authorization) error
	ProcessInvite(string, string) (string, error)
	AcceptInvite(string) error
	RejectInvite(string)
	DeleteContact(string)
	DeleteGroup(string)

	JoinServer(string)
	SendMessageToGroup(string, string) error
	SendMessageToGroupTracked(string, string) (string, error)

	GetName() string
	SetName(string)
	GetOnion() string

	GetPeerState(string) (connections.ConnectionState, bool)

	StartGroup(string) (string, []byte, error)

	ImportGroup(string) error
	ExportGroup(string) (string, error)

	GetGroup(string) *model.Group
	GetGroupState(string) (connections.ConnectionState, bool)
	GetGroups() []string
	AddContact(nick, onion string, authorization model.Authorization)
	GetContacts() []string
	GetContact(string) *model.PublicProfile

	SetAttribute(string, string)
	GetAttribute(string) (string, bool)
	SetContactAttribute(string, string, string)
	GetContactAttribute(string, string) (string, bool)
	SetGroupAttribute(string, string, string)
	GetGroupAttribute(string, string) (string, bool)

	Listen()
	StartPeersConnections()
	StartGroupConnections()
	Shutdown()
}

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.