channeld

package

Go to main page

Versions in this module

v0

v0.7.4

Jun 21, 2024

Changes in this version

+ var Event_EntityChannelSpatiallyOwned = &Event[EntityChannelSpatiallyOwnedEventData]

+ type EntityChannelDataWithSpatialInfo interface

+ GetSpatialInfo func() *common.SpatialInfo

+ type EntityChannelSpatiallyOwnedEventData struct

+ EntityChannel *Channel

+ SpatialChanel *Channel

v0.7.3

Apr 24, 2024

Changes in this version

type GlobalSettingsType

+ ClientNetworkWaitMasterServer bool

v0.7.2

Dec 22, 2023

v0.7.0

Sep 21, 2023

Changes in this version

+ func SetLogLevel(level zapcore.Level)

type Channel

+ func (c *Channel) GetOwner() ConnectionInChannel

+ func (c *Channel) SetOwner(conn ConnectionInChannel)

+ func (ch *Channel) SendMessageToOwner(msgType uint32, msg common.Message) bool

v0.6.0

Jun 6, 2023

Changes in this version

+ var ErrEntityChannelFull = errors.New("entity channels are full")

+ var Event_AuthComplete = &Event[AuthEventData]

+ var Event_ChannelRemoving = &Event[*Channel]

+ func CopyArray(arr []FROM) []TO

+ func GetNextIdTyped(m MapRead[K, V], start K, min K, max K) (K, bool)

+ func UintIdHasher() func(maphash.Seed, T) uint64

+ type AuthEventData struct

+ AuthResult channeldpb.AuthResultMessage_AuthResult

+ Connection ConnectionInChannel

+ PlayerIdentifierToken string

type Channel

+ func (ch *Channel) Execute(callback func(ch *Channel))

+ func (ch *Channel) GetHandoverEntities(notifyingEntityId EntityId) map[EntityId]common.Message

+ func (ch *Channel) Id() common.ChannelId

+ func (ch *Channel) PutMessageInternal(msgType channeldpb.MessageType, msg common.Message)

+ func (ch *Channel) Type() channeldpb.ChannelType

type Connection

+ func (c *Connection) HasInterestIn(spatialChId common.ChannelId) bool

type ConnectionInChannel

+ HasInterestIn func(spatialChId common.ChannelId) bool

+ type EntityGroup struct

+ func (g *EntityGroup) Add(groupToAdd *EntityGroup)

+ type EntityGroupController interface

+ AddToGroup func(t channeldpb.EntityGroupType, entitiesToAdd []EntityId) error

+ GetHandoverEntities func() []EntityId

+ Initialize func(ch *Channel)

+ RemoveFromGroup func(t channeldpb.EntityGroupType, entitiesToRemove []EntityId) error

+ Uninitialize func(ch *Channel)

+ type EntityId uint32

type Event

+ func (e *Event[T]) ListenFor(owner interface{}, handlerFunc func(data T))

+ func (e *Event[T]) UnlistenFor(owner interface{})

+ type FlatEntityGroupController struct

+ func (ctl *FlatEntityGroupController) AddToGroup(t channeldpb.EntityGroupType, entitiesToAdd []EntityId) error

+ func (ctl *FlatEntityGroupController) GetHandoverEntities() []EntityId

+ func (ctl *FlatEntityGroupController) Initialize(ch *Channel)

+ func (ctl *FlatEntityGroupController) RemoveFromGroup(t channeldpb.EntityGroupType, entitiesToRemove []EntityId) error

+ func (ctl *FlatEntityGroupController) Uninitialize(ch *Channel)

type GlobalSettingsType

+ EntityChannelIdStart common.ChannelId

+ type HandoverDataMerger interface

+ MergeTo func(common.Message, bool) error

+ type MapRead interface

+ Load func(key K) (value V, ok bool)

+ type SpatialChannelEntityUpdater interface

+ AddEntity func(EntityId, common.Message) error

+ RemoveEntity func(EntityId) error

+ type UintId interface

v0.5.1

Mar 20, 2023

Changes in this version

+ const ConnectionState_AUTHENTICATED

+ const ConnectionState_CLOSING

+ const ConnectionState_UNAUTHENTICATED

+ const GlobalChannelId

+ const MaxPacketSize

+ const MaxUpdateMsgBufferSize

+ const MaxY

+ const MinY

+ const PacketHeaderSize

+ var ErrIllegalAccessLevel = errors.New("illegal channel access level")

+ var ErrNonSpatialChannelFull = errors.New("non-spatial channels are full")

+ var ErrNoneAccess = errors.New("none can access")

+ var ErrOwnerAndGlobalOwnerAccess = errors.New("only the channel owenr or global channel owner can access")

+ var ErrOwnerOnlyAccess = errors.New("only the channel owenr can access")

+ var ErrSpatialChannelFull = errors.New("spatial channels are full")

+ var Event_AuthFailed = &Event[AuthFailedEventData]

+ var Event_ChannelCreated = &Event[*Channel]

+ var Event_ChannelRemoved = &Event[common.ChannelId]

+ var Event_FsmDisallowed = &Event[*Connection]

+ var Event_GlobalChannelPossessed = &Event[*Channel]

+ var Event_GlobalChannelUnpossessed = &Event[struct{}]

+ var GlobalSettings = GlobalSettingsType

+ var MessageMap = map[channeldpb.MessageType]*messageMapEntry

+ func Difference(thisMap map[K]V, otherMap map[K]V) map[K]V

+ func GetIP(addr net.Addr) string

+ func GetNextId(m *map[uint32]interface{}, start uint32, min uint32, max uint32) (uint32, bool)

+ func GetNextIdSync(m *sync.Map, start common.ChannelId, min common.ChannelId, ...) (common.ChannelId, bool)

+ func HandleServerToClientUserMessage(ctx MessageContext)

+ func HashString(s string) uint32

+ func InitAntiDDoS()

+ func InitChannels()

+ func InitConnections(serverFsmPath string, clientFsmPath string)

+ func InitLogs()

+ func InitMetrics()

+ func InitSpatialController()

+ func Pointer(val K) *K

+ func ReflectChannelDataMessage(channelType channeldpb.ChannelType, ...) (common.ChannelDataMessage, error)

+ func ReflectMerge(dst common.ChannelDataMessage, src common.ChannelDataMessage, ...)

+ func RegisterChannelDataType(channelType channeldpb.ChannelType, msgTemplate proto.Message)

+ func RegisterMessageHandler(msgType uint32, msg common.Message, handler MessageHandlerFunc)

+ func RemoveChannel(ch *Channel)

+ func SetAuthProvider(value AuthProvider)

+ func SetWebSocketTrustedOrigins(addrs []string)

+ func StartListening(t channeldpb.ConnectionType, network string, address string)

+ func StartProfiling()

+ type ACLSettingsType struct

+ Remove ChannelAccessLevel

+ Sub ChannelAccessLevel

+ Unsub ChannelAccessLevel

+ type AlwaysFailAuthProvider struct

+ func (provider *AlwaysFailAuthProvider) DoAuth(connId ConnectionId, pit string, lt string) (channeldpb.AuthResultMessage_AuthResult, error)

+ type AuthFailedEventData struct

+ AuthResult channeldpb.AuthResultMessage_AuthResult

+ Connection ConnectionInChannel

+ PlayerIdentifierToken string

+ type AuthProvider interface

+ DoAuth func(connId ConnectionId, pit string, lt string) (channeldpb.AuthResultMessage_AuthResult, error)

+ type Channel struct

+ func CreateChannel(t channeldpb.ChannelType, owner ConnectionInChannel) (*Channel, error)

+ func GetChannel(id common.ChannelId) *Channel

+ func (ch *Channel) AddConnectionSubscribedNotification(connId ConnectionId)

+ func (ch *Channel) Broadcast(ctx MessageContext)

+ func (ch *Channel) CheckACL(c ConnectionInChannel, accessType ChannelAccessType) (bool, error)

+ func (ch *Channel) Data() *ChannelData

+ func (ch *Channel) GetAllConnections() map[ConnectionInChannel]struct{}

+ func (ch *Channel) GetDataMessage() common.ChannelDataMessage

+ func (ch *Channel) GetTime() ChannelTime

+ func (ch *Channel) HasOwner() bool

+ func (ch *Channel) InitData(dataMsg common.ChannelDataMessage, ...)

+ func (ch *Channel) IsRemoving() bool

+ func (ch *Channel) Logger() *Logger

+ func (ch *Channel) PutMessage(msg common.Message, handler MessageHandlerFunc, conn *Connection, ...)

+ func (ch *Channel) PutMessageContext(ctx MessageContext, handler MessageHandlerFunc)

+ func (ch *Channel) SendToOwner(msgType uint32, msg common.Message)

+ func (ch *Channel) SetDataUpdateConnId(connId ConnectionId)

+ func (ch *Channel) String() string

+ func (ch *Channel) Tick()

+ func (chA *Channel) IsSameOwner(chB *Channel) bool

+ type ChannelAccessLevel uint8

+ const ChannelAccessLevel_Any

+ const ChannelAccessLevel_None

+ const ChannelAccessLevel_OwnerAndGlobalOwner

+ const ChannelAccessLevel_OwnerOnly

+ type ChannelAccessType uint8

+ const ChannelAccessType_Remove

+ const ChannelAccessType_Sub

+ const ChannelAccessType_Unsub

+ type ChannelData struct

+ func (d *ChannelData) OnUpdate(updateMsg common.ChannelDataMessage, t ChannelTime, senderConnId ConnectionId, ...)

+ type ChannelDataInitializer interface

+ Init func() error

+ type ChannelSettingsType struct

+ ACLSettings ACLSettingsType

+ DataMsgFullName string

+ DefaultFanOutDelayMs int32

+ DefaultFanOutIntervalMs uint32

+ RemoveChannelAfterOwnerRemoved bool

+ TickIntervalMs uint

+ type ChannelState uint8

+ const ChannelState_HANDOVER

+ const ChannelState_INIT

+ const ChannelState_OPEN

+ type ChannelSubscription struct

+ type ChannelTime int64

+ func (t ChannelTime) AddMs(ms uint32) ChannelTime

+ func (t ChannelTime) OffsetMs(ms int32) ChannelTime

+ type Connection struct

+ func AddConnection(c net.Conn, t channeldpb.ConnectionType) *Connection

+ func GetConnection(id ConnectionId) *Connection

+ func (c *Connection) AddCloseHandler(handlerFunc func())

+ func (c *Connection) Close()

+ func (c *Connection) Disconnect() error

+ func (c *Connection) GetConnectionType() channeldpb.ConnectionType

+ func (c *Connection) HasAuthorityOver(ch *Channel) bool

+ func (c *Connection) Id() ConnectionId

+ func (c *Connection) IsClosing() bool

+ func (c *Connection) IsNil() bool

+ func (c *Connection) Logger() *Logger

+ func (c *Connection) OnAuthenticated(pit string)

+ func (c *Connection) RemoteAddr() net.Addr

+ func (c *Connection) Send(ctx MessageContext)

+ func (c *Connection) String() string

+ func (c *Connection) SubscribeToChannel(ch *Channel, options *channeldpb.ChannelSubscriptionOptions) *ChannelSubscription

+ func (c *Connection) UnsubscribeFromChannel(ch *Channel) (*channeldpb.ChannelSubscriptionOptions, error)

+ type ConnectionId uint32

+ type ConnectionInChannel interface

+ Close func()

+ GetConnectionType func() channeldpb.ConnectionType

+ HasAuthorityOver func(ch *Channel) bool

+ Id func() ConnectionId

+ IsClosing func() bool

+ Logger func() *Logger

+ OnAuthenticated func(pit string)

+ RemoteAddr func() net.Addr

+ Send func(ctx MessageContext)

+ SubscribeToChannel func(ch *Channel, options *channeldpb.ChannelSubscriptionOptions) *ChannelSubscription

+ UnsubscribeFromChannel func(ch *Channel) (*channeldpb.ChannelSubscriptionOptions, error)

+ type Event struct

+ func (e *Event[T]) Broadcast(data T)

+ func (e *Event[T]) Listen(handlerFunc func(data T))

+ func (e *Event[T]) ListenOnce(handlerFunc func(data T))

+ func (e *Event[T]) Wait() chan T

+ type EventData interface

+ type FixedPasswordAuthProvider struct

+ Password string

+ func (provider *FixedPasswordAuthProvider) DoAuth(connId ConnectionId, pit string, lt string) (channeldpb.AuthResultMessage_AuthResult, error)

+ type GlobalSettingsType struct

+ ChannelSettings map[channeldpb.ChannelType]ChannelSettingsType

+ ClientAddress string

+ ClientFSM string

+ ClientNetwork string

+ ClientReadBufferSize int

+ ClientWriteBufferSize int

+ CompressionType channeldpb.CompressionType

+ ConnectionAuthTimeoutMs int64

+ Development bool

+ EnableRecordPacket bool

+ LogFile *NullableString

+ LogLevel *NullableInt

+ MaxConnectionIdBits uint8

+ MaxFailedAuthAttempts int

+ MaxFsmDisallowed int

+ ProfileOption func(*profile.Profile)

+ ProfilePath string

+ ReplaySessionPersistenceDir string

+ ServerAddress string

+ ServerBypassAuth bool

+ ServerFSM string

+ ServerNetwork string

+ ServerReadBufferSize int

+ ServerWriteBufferSize int

+ SpatialChannelIdStart common.ChannelId

+ SpatialControllerConfig NullableString

+ func (s *GlobalSettingsType) ParseFlag() error

+ func (s GlobalSettingsType) GetChannelSettings(t channeldpb.ChannelType) ChannelSettingsType

+ type HandoverDataWithPayload interface

+ ClearPayload func()

+ type LocalhostAddr struct

+ NetworkName string

+ func (addr *LocalhostAddr) Addr() string

+ func (addr *LocalhostAddr) Network() string

+ type LogLevel zapcore.Level

+ const TraceLevel

+ const VerboseLevel

+ const VeryVerboseLevel

+ type Logger struct

+ func RootLogger() *Logger

+ func (logger *Logger) Trace(msg string, fields ...zap.Field)

+ func (logger *Logger) Verbose(msg string, fields ...zap.Field)

+ func (logger *Logger) VeryVerbose(msg string, fields ...zap.Field)

+ type LoggingAuthProvider struct

+ Logger *zap.Logger

+ Msg string

+ func (provider *LoggingAuthProvider) DoAuth(connId ConnectionId, pit string, lt string) (channeldpb.AuthResultMessage_AuthResult, error)

+ type MergeableChannelData interface

+ Merge func(src common.ChannelDataMessage, options *channeldpb.ChannelDataMergeOptions, ...) error

+ type MessageContext struct

+ Broadcast uint32

+ Channel *Channel

+ ChannelId uint32

+ Connection ConnectionInChannel

+ Msg common.Message

+ MsgType channeldpb.MessageType

+ StubId uint32

+ func (ctx *MessageContext) HasConnection() bool

+ type MessageHandlerFunc func(ctx MessageContext)

+ type MessageSender interface

+ Send func(c *Connection, ctx MessageContext)

+ type NullableInt struct

+ HasValue bool

+ Value int

+ func (i *NullableInt) Set(s string) error

+ func (i NullableInt) String() string

+ type NullableString struct

+ HasValue bool

+ Value string

+ func (ns *NullableString) Set(s string) error

+ func (ns NullableString) String() string

+ type RemovableMapField interface

+ GetRemoved func() bool

+ type SpatialController interface

+ CreateChannels func(ctx MessageContext) ([]*Channel, error)

+ GetAdjacentChannels func(spatialChannelId common.ChannelId) ([]common.ChannelId, error)

+ GetChannelId func(info common.SpatialInfo) (common.ChannelId, error)

+ GetRegions func() ([]*channeldpb.SpatialRegion, error)

+ LoadConfig func(config []byte) error

+ QueryChannelIds func(query *channeldpb.SpatialInterestQuery) (map[common.ChannelId]uint, error)

+ Tick func()

+ func GetSpatialController() SpatialController

+ type SpatialDampingSettings struct

+ DataFieldMasks []string

+ FanOutIntervalMs uint32

+ MaxDistance uint

+ type StaticGrid2DSpatialController struct

+ GridCols uint32

+ GridHeight float64

+ GridRows uint32

+ GridWidth float64

+ ServerCols uint32

+ ServerInterestBorderSize uint32

+ ServerRows uint32

+ WorldOffsetX float64

+ WorldOffsetZ float64

+ func (ctl *StaticGrid2DSpatialController) CreateChannels(ctx MessageContext) ([]*Channel, error)

+ func (ctl *StaticGrid2DSpatialController) GetAdjacentChannels(spatialChannelId common.ChannelId) ([]common.ChannelId, error)

+ func (ctl *StaticGrid2DSpatialController) GetChannelId(info common.SpatialInfo) (common.ChannelId, error)

+ func (ctl *StaticGrid2DSpatialController) GetChannelIdNoOffset(info common.SpatialInfo) (common.ChannelId, error)

+ func (ctl *StaticGrid2DSpatialController) GetChannelIdWithOffset(info common.SpatialInfo, offsetX float64, offsetZ float64) (common.ChannelId, error)

+ func (ctl *StaticGrid2DSpatialController) GetRegions() ([]*channeldpb.SpatialRegion, error)

+ func (ctl *StaticGrid2DSpatialController) GridSize() float64

+ func (ctl *StaticGrid2DSpatialController) LoadConfig(config []byte) error

+ func (ctl *StaticGrid2DSpatialController) Notify(oldInfo common.SpatialInfo, newInfo common.SpatialInfo, ...)

+ func (ctl *StaticGrid2DSpatialController) QueryChannelIds(query *channeldpb.SpatialInterestQuery) (map[common.ChannelId]uint, error)

+ func (ctl *StaticGrid2DSpatialController) Tick()

+ func (ctl *StaticGrid2DSpatialController) WorldHeight() float64

+ func (ctl *StaticGrid2DSpatialController) WorldWidth() float64

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL