Home Reference Source
import AbstractConnector from 'yjs/src/Connector.js'
public class | source

AbstractConnector

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public
public
public
public
public
public
public
public

debug: *

public
public

log: *

public
public
public

opts: *

public
public
public
public
public

y: *

Method Summary

Public Methods
public

broadcast(buffer: *)

public

broadcastStruct(struct: *)

public

computeMessage(messageType: *, senderConn: *, decoder: *, encoder: *, sender: *, skipAuth: *)

public

disconnect(): *

public

onUserEvent(f: *)

public

receiveMessage(sender: *, buffer: *, skipAuth: *): *

public
public
public

send(uid: *, buffer: *)

public

userJoined(user: *, role: *, auth: *)

public

userLeft(user: *)

public
public

whenSynced(f: *)

Public Constructors

public constructor() source

Public Members

public authInfo: * source

public broadcastBuffer: * source

public broadcastBufferSize: number source

public broadcastBufferSizePos: * source

public checkAuth: * source

public connections: * source

public currentSyncTarget: * source

public debug: * source

public isSynced: boolean source

public log: * source

public logMessage: * source

public maxBufferLength: * source

public opts: * source

public protocolVersion: number source

public role: string source

public userEventListeners: *[] source

public whenSyncedListeners: *[] source

public y: * source

Public Methods

public broadcast(buffer: *) source

Params:

NameTypeAttributeDescription
buffer *

public broadcastStruct(struct: *) source

Params:

NameTypeAttributeDescription
struct *

public computeMessage(messageType: *, senderConn: *, decoder: *, encoder: *, sender: *, skipAuth: *) source

Params:

NameTypeAttributeDescription
messageType *
senderConn *
decoder *
encoder *
sender *
skipAuth *

public disconnect(): * source

Return:

*

public onUserEvent(f: *) source

Params:

NameTypeAttributeDescription
f *

public receiveMessage(sender: *, buffer: *, skipAuth: *): * source

Params:

NameTypeAttributeDescription
sender *
buffer *
skipAuth *

Return:

*

public reconnect() source

public removeUserEventListener(f: *) source

Params:

NameTypeAttributeDescription
f *

public send(uid: *, buffer: *) source

Params:

NameTypeAttributeDescription
uid *
buffer *

public userJoined(user: *, role: *, auth: *) source

Params:

NameTypeAttributeDescription
user *
role *
auth *

public userLeft(user: *) source

Params:

NameTypeAttributeDescription
user *

public whenRemoteResponsive(): * source

Return:

*

public whenSynced(f: *) source

Params:

NameTypeAttributeDescription
f *