bertymessenger

README

Berty go/pkg/bertymessenger

Please, read the main README.md file first.

Usage

import "berty.tech/berty/v2/go/pkg/bertymessenger"

Get the code

git clone https://github.com/berty/berty
cd berty/go/pkg/bertymessenger

Documentation

Overview

Package bertymessenger contains the top-level API that uses the Berty Protocol to implement the Berty Messenger specific logic.

Index

• Constants
• func RestoreFromAccountExport(ctx context.Context, reader io.Reader, coreAPI ipfs_interface.CoreAPI, ...) error
• func TestingInfra(ctx context.Context, t *testing.T, amount int, logger *zap.Logger) ([]messengertypes.MessengerServiceClient, []*bertyprotocol.TestingProtocol, ...)
• func TestingService(ctx context.Context, t *testing.T, opts *TestingServiceOpts) (messengertypes.MessengerServiceServer, func())
• type Dispatcher
  • func NewDispatcher() *Dispatcher
  • func (d *Dispatcher) IsEnabled() bool
  • func (d *Dispatcher) Notify(typ messengertypes.StreamEvent_Notified_Type, title, body string, ...) error
  • func (d *Dispatcher) Register(n Notifiee) func()
  • func (d *Dispatcher) StreamEvent(typ messengertypes.StreamEvent_Type, msg proto.Message, isNew bool) error
  • func (d *Dispatcher) Unregister(n Notifiee)
  • func (d *Dispatcher) UnregisterAll()
• type MetaFetcherFromProtocolClient
  • func (svc *MetaFetcherFromProtocolClient) GroupPKForContact(ctx context.Context, contactPK []byte) ([]byte, error)
  • func (svc *MetaFetcherFromProtocolClient) OwnMemberAndDevicePKForConversation(ctx context.Context, conversationPK []byte) (member []byte, device []byte, err error)
• type Notifiee
• type NotifieeBundle
  • func (nb *NotifieeBundle) StreamEvent(c *messengertypes.StreamEvent) error
• type Opts
• type RecvEvent
• type Service
  • func New(client protocoltypes.ProtocolServiceClient, opts *Opts) (_ Service, err error)
• type TestingAccount
  • func NewTestingAccount(ctx context.Context, t *testing.T, ...) *TestingAccount
  • func Testing1To1ProcessWholeStream(t *testing.T) (context.Context, []*TestingAccount, *zap.Logger, func())
  • func (a *TestingAccount) Close()
  • func (a *TestingAccount) DrainInitEvents(t *testing.T)
  • func (a *TestingAccount) GetAccount() *messengertypes.Account
  • func (a *TestingAccount) GetAllContacts() map[string]*messengertypes.Contact
  • func (a *TestingAccount) GetAllConversations() map[string]*messengertypes.Conversation
  • func (a *TestingAccount) GetClient() messengertypes.MessengerServiceClient
  • func (a *TestingAccount) GetContact(t *testing.T, pk string) *messengertypes.Contact
  • func (a *TestingAccount) GetConversation(t *testing.T, pk string) *messengertypes.Conversation
  • func (a *TestingAccount) GetInteraction(t *testing.T, cid string) *messengertypes.Interaction
  • func (a *TestingAccount) GetMedia(t *testing.T, cid string) *messengertypes.Media
  • func (a *TestingAccount) GetMember(t *testing.T, pk string) *messengertypes.Member
  • func (a *TestingAccount) GetStream(t *testing.T) <-chan *RecvEvent
  • func (a *TestingAccount) NextEvent(t *testing.T) *messengertypes.StreamEvent
  • func (a *TestingAccount) ProcessWholeStream(t *testing.T) func()
  • func (a *TestingAccount) SetName(t *testing.T, name string)
  • func (a *TestingAccount) SetNameAndDrainUpdate(t *testing.T, name string)
  • func (a *TestingAccount) TryNextEvent(t *testing.T, timeout time.Duration) *messengertypes.StreamEvent
• type TestingServiceOpts

Constants

const (
	StateActive lifecycle.State = iota
	StateInactive
)

Functions

func RestoreFromAccountExport

func RestoreFromAccountExport(ctx context.Context, reader io.Reader, coreAPI ipfs_interface.CoreAPI, odb *bertyprotocol.BertyOrbitDB, localDBState *mt.LocalDatabaseState, logger *zap.Logger) error

func TestingInfra

func TestingInfra(ctx context.Context, t *testing.T, amount int, logger *zap.Logger) ([]messengertypes.MessengerServiceClient, []*bertyprotocol.TestingProtocol, func())

func TestingService

func TestingService(ctx context.Context, t *testing.T, opts *TestingServiceOpts) (messengertypes.MessengerServiceServer, func())

Types

type Dispatcher

type Dispatcher struct {
	// contains filtered or unexported fields
}

func NewDispatcher

func NewDispatcher() *Dispatcher

func (*Dispatcher) IsEnabled

func (d *Dispatcher) IsEnabled() bool

func (*Dispatcher) Notify

func (d *Dispatcher) Notify(typ messengertypes.StreamEvent_Notified_Type, title, body string, msg proto.Message) error

func (*Dispatcher) Register

func (d *Dispatcher) Register(n Notifiee) func()

func (*Dispatcher) StreamEvent

func (d *Dispatcher) StreamEvent(typ messengertypes.StreamEvent_Type, msg proto.Message, isNew bool) error

func (*Dispatcher) Unregister

func (d *Dispatcher) Unregister(n Notifiee)

func (*Dispatcher) UnregisterAll

func (d *Dispatcher) UnregisterAll()

type MetaFetcherFromProtocolClient

type MetaFetcherFromProtocolClient struct {
	// contains filtered or unexported fields
}

func (*MetaFetcherFromProtocolClient) GroupPKForContact

func (svc *MetaFetcherFromProtocolClient) GroupPKForContact(ctx context.Context, contactPK []byte) ([]byte, error)

func (*MetaFetcherFromProtocolClient) OwnMemberAndDevicePKForConversation

func (svc *MetaFetcherFromProtocolClient) OwnMemberAndDevicePKForConversation(ctx context.Context, conversationPK []byte) (member []byte, device []byte, err error)

type Notifiee

type Notifiee interface {
	StreamEvent(*messengertypes.StreamEvent) error
}

Notifiee system inspired from ipfs

type NotifieeBundle

type NotifieeBundle struct {
	StreamEventImpl func(c *messengertypes.StreamEvent) error
}

func (*NotifieeBundle) StreamEvent

func (nb *NotifieeBundle) StreamEvent(c *messengertypes.StreamEvent) error

type Opts

type Opts struct {
	EnableGroupMonitor  bool
	Logger              *zap.Logger
	DB                  *gorm.DB
	NotificationManager notification.Manager
	LifeCycleManager    *lifecycle.Manager
	StateBackup         *mt.LocalDatabaseState
	PlatformPushToken   *protocoltypes.PushServiceReceiver
	Ring                *zapring.Core

	// LogFilePath defines the location of the current session's log file.
	//
	// This variable is used by svc.TyberHostAttach.
	LogFilePath string
}

type RecvEvent

type RecvEvent struct {
	// contains filtered or unexported fields
}

type Service

type Service interface {
	mt.MessengerServiceServer
	Close()
}

func New

func New(client protocoltypes.ProtocolServiceClient, opts *Opts) (_ Service, err error)

type TestingAccount

type TestingAccount struct {
	// contains filtered or unexported fields
}

func NewTestingAccount

func NewTestingAccount(ctx context.Context, t *testing.T, client messengertypes.MessengerServiceClient, protocolClient protocoltypes.ProtocolServiceClient, logger *zap.Logger) *TestingAccount

func Testing1To1ProcessWholeStream

func Testing1To1ProcessWholeStream(t *testing.T) (context.Context, []*TestingAccount, *zap.Logger, func())

func (*TestingAccount) Close

func (a *TestingAccount) Close()

func (*TestingAccount) DrainInitEvents

func (a *TestingAccount) DrainInitEvents(t *testing.T)

func (*TestingAccount) GetAccount

func (a *TestingAccount) GetAccount() *messengertypes.Account

func (*TestingAccount) GetAllContacts

func (a *TestingAccount) GetAllContacts() map[string]*messengertypes.Contact

func (*TestingAccount) GetAllConversations

func (a *TestingAccount) GetAllConversations() map[string]*messengertypes.Conversation

func (*TestingAccount) GetClient

func (a *TestingAccount) GetClient() messengertypes.MessengerServiceClient

func (*TestingAccount) GetContact

func (a *TestingAccount) GetContact(t *testing.T, pk string) *messengertypes.Contact

func (*TestingAccount) GetConversation

func (a *TestingAccount) GetConversation(t *testing.T, pk string) *messengertypes.Conversation

func (*TestingAccount) GetInteraction

func (a *TestingAccount) GetInteraction(t *testing.T, cid string) *messengertypes.Interaction

func (*TestingAccount) GetMedia

func (a *TestingAccount) GetMedia(t *testing.T, cid string) *messengertypes.Media

func (*TestingAccount) GetMember

func (a *TestingAccount) GetMember(t *testing.T, pk string) *messengertypes.Member

func (*TestingAccount) GetStream

func (a *TestingAccount) GetStream(t *testing.T) <-chan *RecvEvent

func (*TestingAccount) NextEvent

func (a *TestingAccount) NextEvent(t *testing.T) *messengertypes.StreamEvent

func (*TestingAccount) ProcessWholeStream

func (a *TestingAccount) ProcessWholeStream(t *testing.T) func()

func (*TestingAccount) SetName

func (a *TestingAccount) SetName(t *testing.T, name string)

func (*TestingAccount) SetNameAndDrainUpdate

func (a *TestingAccount) SetNameAndDrainUpdate(t *testing.T, name string)

func (*TestingAccount) TryNextEvent

func (a *TestingAccount) TryNextEvent(t *testing.T, timeout time.Duration) *messengertypes.StreamEvent

type TestingServiceOpts

type TestingServiceOpts struct {
	Logger      *zap.Logger
	Client      bertyprotocol.Client
	Index       int
	Ring        *zapring.Core
	LogFilePath string
}