diff --git a/README.md b/README.md
index 1aff80e3..11ab1eaf 100644
--- a/README.md
+++ b/README.md
@@ -27,6 +27,8 @@ Library highlights:
* Possibility to register a custom PUB/SUB Broker and PresenceManager implementations
* Option to register custom Transport, like [Centrifugo does with WebTransport](https://centrifugal.dev/docs/transports/webtransport)
* Message recovery mechanism for channels to survive PUB/SUB delivery problems, short network disconnects or node restart
+* Cache channels – a way to quickly deliver latest publication from channel history to the client upon subscription
+* Delta compression for publications inside a channel to reduce bandwidth usage
* Out-of-the-box Prometheus instrumentation
* Client SDKs for main application environments all following [single behaviour spec](https://centrifugal.dev/docs/transports/client_api) (see list of SDKs below).
diff --git a/_examples/chat_json/index.html b/_examples/chat_json/index.html
index 76b7bfb4..d8c671a3 100644
--- a/_examples/chat_json/index.html
+++ b/_examples/chat_json/index.html
@@ -224,7 +224,7 @@
// subscribe on channel and bind various event listeners. Actual
// subscription request will be sent after client connects to
// a server.
- const sub = centrifuge.newSubscription(channel);
+ const sub = centrifuge.newSubscription(channel, {});
sub.on("publication", handlePublication)
.on("join", handleJoin)
diff --git a/_examples/chat_json/main.go b/_examples/chat_json/main.go
index cfcca570..c460c47a 100644
--- a/_examples/chat_json/main.go
+++ b/_examples/chat_json/main.go
@@ -250,11 +250,12 @@ func main() {
server := &http.Server{
Handler: mux,
- Addr: ":" + strconv.Itoa(*port),
+ Addr: "127.0.0.1:" + strconv.Itoa(*port),
ReadTimeout: 10 * time.Second,
WriteTimeout: 10 * time.Second,
}
+ log.Print("Starting server, visit http://localhost:8000")
go func() {
if err := server.ListenAndServe(); err != nil && !errors.Is(err, http.ErrServerClosed) {
log.Fatal(err)
diff --git a/_examples/compression_playground/apppb/app.pb.go b/_examples/compression_playground/apppb/app.pb.go
new file mode 100644
index 00000000..70f98cb0
--- /dev/null
+++ b/_examples/compression_playground/apppb/app.pb.go
@@ -0,0 +1,475 @@
+// Code generated by protoc-gen-go. DO NOT EDIT.
+// versions:
+// protoc-gen-go v1.32.0
+// protoc v4.25.3
+// source: app.proto
+
+package apppb
+
+import (
+ protoreflect "google.golang.org/protobuf/reflect/protoreflect"
+ protoimpl "google.golang.org/protobuf/runtime/protoimpl"
+ reflect "reflect"
+ sync "sync"
+)
+
+const (
+ // Verify that this generated code is sufficiently up-to-date.
+ _ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion)
+ // Verify that runtime/protoimpl is sufficiently up-to-date.
+ _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
+)
+
+type EventType int32
+
+const (
+ EventType_UNKNOWN EventType = 0 // Default value, should not be used
+ EventType_GOAL EventType = 1
+ EventType_YELLOW_CARD EventType = 2
+ EventType_RED_CARD EventType = 3
+ EventType_SUBSTITUTE EventType = 4
+)
+
+// Enum value maps for EventType.
+var (
+ EventType_name = map[int32]string{
+ 0: "UNKNOWN",
+ 1: "GOAL",
+ 2: "YELLOW_CARD",
+ 3: "RED_CARD",
+ 4: "SUBSTITUTE",
+ }
+ EventType_value = map[string]int32{
+ "UNKNOWN": 0,
+ "GOAL": 1,
+ "YELLOW_CARD": 2,
+ "RED_CARD": 3,
+ "SUBSTITUTE": 4,
+ }
+)
+
+func (x EventType) Enum() *EventType {
+ p := new(EventType)
+ *p = x
+ return p
+}
+
+func (x EventType) String() string {
+ return protoimpl.X.EnumStringOf(x.Descriptor(), protoreflect.EnumNumber(x))
+}
+
+func (EventType) Descriptor() protoreflect.EnumDescriptor {
+ return file_app_proto_enumTypes[0].Descriptor()
+}
+
+func (EventType) Type() protoreflect.EnumType {
+ return &file_app_proto_enumTypes[0]
+}
+
+func (x EventType) Number() protoreflect.EnumNumber {
+ return protoreflect.EnumNumber(x)
+}
+
+// Deprecated: Use EventType.Descriptor instead.
+func (EventType) EnumDescriptor() ([]byte, []int) {
+ return file_app_proto_rawDescGZIP(), []int{0}
+}
+
+type Event struct {
+ state protoimpl.MessageState
+ sizeCache protoimpl.SizeCache
+ unknownFields protoimpl.UnknownFields
+
+ Type EventType `protobuf:"varint,1,opt,name=type,proto3,enum=centrifugal.centrifuge.examples.compression_playground.EventType" json:"type,omitempty"`
+ Minute int32 `protobuf:"varint,2,opt,name=minute,proto3" json:"minute,omitempty"`
+}
+
+func (x *Event) Reset() {
+ *x = Event{}
+ if protoimpl.UnsafeEnabled {
+ mi := &file_app_proto_msgTypes[0]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+ }
+}
+
+func (x *Event) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*Event) ProtoMessage() {}
+
+func (x *Event) ProtoReflect() protoreflect.Message {
+ mi := &file_app_proto_msgTypes[0]
+ if protoimpl.UnsafeEnabled && x != nil {
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ if ms.LoadMessageInfo() == nil {
+ ms.StoreMessageInfo(mi)
+ }
+ return ms
+ }
+ return mi.MessageOf(x)
+}
+
+// Deprecated: Use Event.ProtoReflect.Descriptor instead.
+func (*Event) Descriptor() ([]byte, []int) {
+ return file_app_proto_rawDescGZIP(), []int{0}
+}
+
+func (x *Event) GetType() EventType {
+ if x != nil {
+ return x.Type
+ }
+ return EventType_UNKNOWN
+}
+
+func (x *Event) GetMinute() int32 {
+ if x != nil {
+ return x.Minute
+ }
+ return 0
+}
+
+type Player struct {
+ state protoimpl.MessageState
+ sizeCache protoimpl.SizeCache
+ unknownFields protoimpl.UnknownFields
+
+ Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
+ Events []*Event `protobuf:"bytes,2,rep,name=events,proto3" json:"events,omitempty"`
+}
+
+func (x *Player) Reset() {
+ *x = Player{}
+ if protoimpl.UnsafeEnabled {
+ mi := &file_app_proto_msgTypes[1]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+ }
+}
+
+func (x *Player) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*Player) ProtoMessage() {}
+
+func (x *Player) ProtoReflect() protoreflect.Message {
+ mi := &file_app_proto_msgTypes[1]
+ if protoimpl.UnsafeEnabled && x != nil {
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ if ms.LoadMessageInfo() == nil {
+ ms.StoreMessageInfo(mi)
+ }
+ return ms
+ }
+ return mi.MessageOf(x)
+}
+
+// Deprecated: Use Player.ProtoReflect.Descriptor instead.
+func (*Player) Descriptor() ([]byte, []int) {
+ return file_app_proto_rawDescGZIP(), []int{1}
+}
+
+func (x *Player) GetName() string {
+ if x != nil {
+ return x.Name
+ }
+ return ""
+}
+
+func (x *Player) GetEvents() []*Event {
+ if x != nil {
+ return x.Events
+ }
+ return nil
+}
+
+type Team struct {
+ state protoimpl.MessageState
+ sizeCache protoimpl.SizeCache
+ unknownFields protoimpl.UnknownFields
+
+ Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
+ Score int32 `protobuf:"varint,2,opt,name=score,proto3" json:"score,omitempty"`
+ Players []*Player `protobuf:"bytes,3,rep,name=players,proto3" json:"players,omitempty"`
+}
+
+func (x *Team) Reset() {
+ *x = Team{}
+ if protoimpl.UnsafeEnabled {
+ mi := &file_app_proto_msgTypes[2]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+ }
+}
+
+func (x *Team) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*Team) ProtoMessage() {}
+
+func (x *Team) ProtoReflect() protoreflect.Message {
+ mi := &file_app_proto_msgTypes[2]
+ if protoimpl.UnsafeEnabled && x != nil {
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ if ms.LoadMessageInfo() == nil {
+ ms.StoreMessageInfo(mi)
+ }
+ return ms
+ }
+ return mi.MessageOf(x)
+}
+
+// Deprecated: Use Team.ProtoReflect.Descriptor instead.
+func (*Team) Descriptor() ([]byte, []int) {
+ return file_app_proto_rawDescGZIP(), []int{2}
+}
+
+func (x *Team) GetName() string {
+ if x != nil {
+ return x.Name
+ }
+ return ""
+}
+
+func (x *Team) GetScore() int32 {
+ if x != nil {
+ return x.Score
+ }
+ return 0
+}
+
+func (x *Team) GetPlayers() []*Player {
+ if x != nil {
+ return x.Players
+ }
+ return nil
+}
+
+type Match struct {
+ state protoimpl.MessageState
+ sizeCache protoimpl.SizeCache
+ unknownFields protoimpl.UnknownFields
+
+ Id int32 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
+ HomeTeam *Team `protobuf:"bytes,2,opt,name=home_team,json=homeTeam,proto3" json:"home_team,omitempty"`
+ AwayTeam *Team `protobuf:"bytes,3,opt,name=away_team,json=awayTeam,proto3" json:"away_team,omitempty"`
+}
+
+func (x *Match) Reset() {
+ *x = Match{}
+ if protoimpl.UnsafeEnabled {
+ mi := &file_app_proto_msgTypes[3]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+ }
+}
+
+func (x *Match) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*Match) ProtoMessage() {}
+
+func (x *Match) ProtoReflect() protoreflect.Message {
+ mi := &file_app_proto_msgTypes[3]
+ if protoimpl.UnsafeEnabled && x != nil {
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ if ms.LoadMessageInfo() == nil {
+ ms.StoreMessageInfo(mi)
+ }
+ return ms
+ }
+ return mi.MessageOf(x)
+}
+
+// Deprecated: Use Match.ProtoReflect.Descriptor instead.
+func (*Match) Descriptor() ([]byte, []int) {
+ return file_app_proto_rawDescGZIP(), []int{3}
+}
+
+func (x *Match) GetId() int32 {
+ if x != nil {
+ return x.Id
+ }
+ return 0
+}
+
+func (x *Match) GetHomeTeam() *Team {
+ if x != nil {
+ return x.HomeTeam
+ }
+ return nil
+}
+
+func (x *Match) GetAwayTeam() *Team {
+ if x != nil {
+ return x.AwayTeam
+ }
+ return nil
+}
+
+var File_app_proto protoreflect.FileDescriptor
+
+var file_app_proto_rawDesc = []byte{
+ 0x0a, 0x09, 0x61, 0x70, 0x70, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x12, 0x36, 0x63, 0x65, 0x6e,
+ 0x74, 0x72, 0x69, 0x66, 0x75, 0x67, 0x61, 0x6c, 0x2e, 0x63, 0x65, 0x6e, 0x74, 0x72, 0x69, 0x66,
+ 0x75, 0x67, 0x65, 0x2e, 0x65, 0x78, 0x61, 0x6d, 0x70, 0x6c, 0x65, 0x73, 0x2e, 0x63, 0x6f, 0x6d,
+ 0x70, 0x72, 0x65, 0x73, 0x73, 0x69, 0x6f, 0x6e, 0x5f, 0x70, 0x6c, 0x61, 0x79, 0x67, 0x72, 0x6f,
+ 0x75, 0x6e, 0x64, 0x22, 0x76, 0x0a, 0x05, 0x45, 0x76, 0x65, 0x6e, 0x74, 0x12, 0x55, 0x0a, 0x04,
+ 0x74, 0x79, 0x70, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x0e, 0x32, 0x41, 0x2e, 0x63, 0x65, 0x6e,
+ 0x74, 0x72, 0x69, 0x66, 0x75, 0x67, 0x61, 0x6c, 0x2e, 0x63, 0x65, 0x6e, 0x74, 0x72, 0x69, 0x66,
+ 0x75, 0x67, 0x65, 0x2e, 0x65, 0x78, 0x61, 0x6d, 0x70, 0x6c, 0x65, 0x73, 0x2e, 0x63, 0x6f, 0x6d,
+ 0x70, 0x72, 0x65, 0x73, 0x73, 0x69, 0x6f, 0x6e, 0x5f, 0x70, 0x6c, 0x61, 0x79, 0x67, 0x72, 0x6f,
+ 0x75, 0x6e, 0x64, 0x2e, 0x45, 0x76, 0x65, 0x6e, 0x74, 0x54, 0x79, 0x70, 0x65, 0x52, 0x04, 0x74,
+ 0x79, 0x70, 0x65, 0x12, 0x16, 0x0a, 0x06, 0x6d, 0x69, 0x6e, 0x75, 0x74, 0x65, 0x18, 0x02, 0x20,
+ 0x01, 0x28, 0x05, 0x52, 0x06, 0x6d, 0x69, 0x6e, 0x75, 0x74, 0x65, 0x22, 0x73, 0x0a, 0x06, 0x50,
+ 0x6c, 0x61, 0x79, 0x65, 0x72, 0x12, 0x12, 0x0a, 0x04, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x01, 0x20,
+ 0x01, 0x28, 0x09, 0x52, 0x04, 0x6e, 0x61, 0x6d, 0x65, 0x12, 0x55, 0x0a, 0x06, 0x65, 0x76, 0x65,
+ 0x6e, 0x74, 0x73, 0x18, 0x02, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x3d, 0x2e, 0x63, 0x65, 0x6e, 0x74,
+ 0x72, 0x69, 0x66, 0x75, 0x67, 0x61, 0x6c, 0x2e, 0x63, 0x65, 0x6e, 0x74, 0x72, 0x69, 0x66, 0x75,
+ 0x67, 0x65, 0x2e, 0x65, 0x78, 0x61, 0x6d, 0x70, 0x6c, 0x65, 0x73, 0x2e, 0x63, 0x6f, 0x6d, 0x70,
+ 0x72, 0x65, 0x73, 0x73, 0x69, 0x6f, 0x6e, 0x5f, 0x70, 0x6c, 0x61, 0x79, 0x67, 0x72, 0x6f, 0x75,
+ 0x6e, 0x64, 0x2e, 0x45, 0x76, 0x65, 0x6e, 0x74, 0x52, 0x06, 0x65, 0x76, 0x65, 0x6e, 0x74, 0x73,
+ 0x22, 0x8a, 0x01, 0x0a, 0x04, 0x54, 0x65, 0x61, 0x6d, 0x12, 0x12, 0x0a, 0x04, 0x6e, 0x61, 0x6d,
+ 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x04, 0x6e, 0x61, 0x6d, 0x65, 0x12, 0x14, 0x0a,
+ 0x05, 0x73, 0x63, 0x6f, 0x72, 0x65, 0x18, 0x02, 0x20, 0x01, 0x28, 0x05, 0x52, 0x05, 0x73, 0x63,
+ 0x6f, 0x72, 0x65, 0x12, 0x58, 0x0a, 0x07, 0x70, 0x6c, 0x61, 0x79, 0x65, 0x72, 0x73, 0x18, 0x03,
+ 0x20, 0x03, 0x28, 0x0b, 0x32, 0x3e, 0x2e, 0x63, 0x65, 0x6e, 0x74, 0x72, 0x69, 0x66, 0x75, 0x67,
+ 0x61, 0x6c, 0x2e, 0x63, 0x65, 0x6e, 0x74, 0x72, 0x69, 0x66, 0x75, 0x67, 0x65, 0x2e, 0x65, 0x78,
+ 0x61, 0x6d, 0x70, 0x6c, 0x65, 0x73, 0x2e, 0x63, 0x6f, 0x6d, 0x70, 0x72, 0x65, 0x73, 0x73, 0x69,
+ 0x6f, 0x6e, 0x5f, 0x70, 0x6c, 0x61, 0x79, 0x67, 0x72, 0x6f, 0x75, 0x6e, 0x64, 0x2e, 0x50, 0x6c,
+ 0x61, 0x79, 0x65, 0x72, 0x52, 0x07, 0x70, 0x6c, 0x61, 0x79, 0x65, 0x72, 0x73, 0x22, 0xcd, 0x01,
+ 0x0a, 0x05, 0x4d, 0x61, 0x74, 0x63, 0x68, 0x12, 0x0e, 0x0a, 0x02, 0x69, 0x64, 0x18, 0x01, 0x20,
+ 0x01, 0x28, 0x05, 0x52, 0x02, 0x69, 0x64, 0x12, 0x59, 0x0a, 0x09, 0x68, 0x6f, 0x6d, 0x65, 0x5f,
+ 0x74, 0x65, 0x61, 0x6d, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x3c, 0x2e, 0x63, 0x65, 0x6e,
+ 0x74, 0x72, 0x69, 0x66, 0x75, 0x67, 0x61, 0x6c, 0x2e, 0x63, 0x65, 0x6e, 0x74, 0x72, 0x69, 0x66,
+ 0x75, 0x67, 0x65, 0x2e, 0x65, 0x78, 0x61, 0x6d, 0x70, 0x6c, 0x65, 0x73, 0x2e, 0x63, 0x6f, 0x6d,
+ 0x70, 0x72, 0x65, 0x73, 0x73, 0x69, 0x6f, 0x6e, 0x5f, 0x70, 0x6c, 0x61, 0x79, 0x67, 0x72, 0x6f,
+ 0x75, 0x6e, 0x64, 0x2e, 0x54, 0x65, 0x61, 0x6d, 0x52, 0x08, 0x68, 0x6f, 0x6d, 0x65, 0x54, 0x65,
+ 0x61, 0x6d, 0x12, 0x59, 0x0a, 0x09, 0x61, 0x77, 0x61, 0x79, 0x5f, 0x74, 0x65, 0x61, 0x6d, 0x18,
+ 0x03, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x3c, 0x2e, 0x63, 0x65, 0x6e, 0x74, 0x72, 0x69, 0x66, 0x75,
+ 0x67, 0x61, 0x6c, 0x2e, 0x63, 0x65, 0x6e, 0x74, 0x72, 0x69, 0x66, 0x75, 0x67, 0x65, 0x2e, 0x65,
+ 0x78, 0x61, 0x6d, 0x70, 0x6c, 0x65, 0x73, 0x2e, 0x63, 0x6f, 0x6d, 0x70, 0x72, 0x65, 0x73, 0x73,
+ 0x69, 0x6f, 0x6e, 0x5f, 0x70, 0x6c, 0x61, 0x79, 0x67, 0x72, 0x6f, 0x75, 0x6e, 0x64, 0x2e, 0x54,
+ 0x65, 0x61, 0x6d, 0x52, 0x08, 0x61, 0x77, 0x61, 0x79, 0x54, 0x65, 0x61, 0x6d, 0x2a, 0x51, 0x0a,
+ 0x09, 0x45, 0x76, 0x65, 0x6e, 0x74, 0x54, 0x79, 0x70, 0x65, 0x12, 0x0b, 0x0a, 0x07, 0x55, 0x4e,
+ 0x4b, 0x4e, 0x4f, 0x57, 0x4e, 0x10, 0x00, 0x12, 0x08, 0x0a, 0x04, 0x47, 0x4f, 0x41, 0x4c, 0x10,
+ 0x01, 0x12, 0x0f, 0x0a, 0x0b, 0x59, 0x45, 0x4c, 0x4c, 0x4f, 0x57, 0x5f, 0x43, 0x41, 0x52, 0x44,
+ 0x10, 0x02, 0x12, 0x0c, 0x0a, 0x08, 0x52, 0x45, 0x44, 0x5f, 0x43, 0x41, 0x52, 0x44, 0x10, 0x03,
+ 0x12, 0x0e, 0x0a, 0x0a, 0x53, 0x55, 0x42, 0x53, 0x54, 0x49, 0x54, 0x55, 0x54, 0x45, 0x10, 0x04,
+ 0x42, 0x0a, 0x5a, 0x08, 0x2e, 0x2f, 0x3b, 0x61, 0x70, 0x70, 0x70, 0x62, 0x62, 0x06, 0x70, 0x72,
+ 0x6f, 0x74, 0x6f, 0x33,
+}
+
+var (
+ file_app_proto_rawDescOnce sync.Once
+ file_app_proto_rawDescData = file_app_proto_rawDesc
+)
+
+func file_app_proto_rawDescGZIP() []byte {
+ file_app_proto_rawDescOnce.Do(func() {
+ file_app_proto_rawDescData = protoimpl.X.CompressGZIP(file_app_proto_rawDescData)
+ })
+ return file_app_proto_rawDescData
+}
+
+var file_app_proto_enumTypes = make([]protoimpl.EnumInfo, 1)
+var file_app_proto_msgTypes = make([]protoimpl.MessageInfo, 4)
+var file_app_proto_goTypes = []interface{}{
+ (EventType)(0), // 0: centrifugal.centrifuge.examples.compression_playground.EventType
+ (*Event)(nil), // 1: centrifugal.centrifuge.examples.compression_playground.Event
+ (*Player)(nil), // 2: centrifugal.centrifuge.examples.compression_playground.Player
+ (*Team)(nil), // 3: centrifugal.centrifuge.examples.compression_playground.Team
+ (*Match)(nil), // 4: centrifugal.centrifuge.examples.compression_playground.Match
+}
+var file_app_proto_depIdxs = []int32{
+ 0, // 0: centrifugal.centrifuge.examples.compression_playground.Event.type:type_name -> centrifugal.centrifuge.examples.compression_playground.EventType
+ 1, // 1: centrifugal.centrifuge.examples.compression_playground.Player.events:type_name -> centrifugal.centrifuge.examples.compression_playground.Event
+ 2, // 2: centrifugal.centrifuge.examples.compression_playground.Team.players:type_name -> centrifugal.centrifuge.examples.compression_playground.Player
+ 3, // 3: centrifugal.centrifuge.examples.compression_playground.Match.home_team:type_name -> centrifugal.centrifuge.examples.compression_playground.Team
+ 3, // 4: centrifugal.centrifuge.examples.compression_playground.Match.away_team:type_name -> centrifugal.centrifuge.examples.compression_playground.Team
+ 5, // [5:5] is the sub-list for method output_type
+ 5, // [5:5] is the sub-list for method input_type
+ 5, // [5:5] is the sub-list for extension type_name
+ 5, // [5:5] is the sub-list for extension extendee
+ 0, // [0:5] is the sub-list for field type_name
+}
+
+func init() { file_app_proto_init() }
+func file_app_proto_init() {
+ if File_app_proto != nil {
+ return
+ }
+ if !protoimpl.UnsafeEnabled {
+ file_app_proto_msgTypes[0].Exporter = func(v interface{}, i int) interface{} {
+ switch v := v.(*Event); i {
+ case 0:
+ return &v.state
+ case 1:
+ return &v.sizeCache
+ case 2:
+ return &v.unknownFields
+ default:
+ return nil
+ }
+ }
+ file_app_proto_msgTypes[1].Exporter = func(v interface{}, i int) interface{} {
+ switch v := v.(*Player); i {
+ case 0:
+ return &v.state
+ case 1:
+ return &v.sizeCache
+ case 2:
+ return &v.unknownFields
+ default:
+ return nil
+ }
+ }
+ file_app_proto_msgTypes[2].Exporter = func(v interface{}, i int) interface{} {
+ switch v := v.(*Team); i {
+ case 0:
+ return &v.state
+ case 1:
+ return &v.sizeCache
+ case 2:
+ return &v.unknownFields
+ default:
+ return nil
+ }
+ }
+ file_app_proto_msgTypes[3].Exporter = func(v interface{}, i int) interface{} {
+ switch v := v.(*Match); i {
+ case 0:
+ return &v.state
+ case 1:
+ return &v.sizeCache
+ case 2:
+ return &v.unknownFields
+ default:
+ return nil
+ }
+ }
+ }
+ type x struct{}
+ out := protoimpl.TypeBuilder{
+ File: protoimpl.DescBuilder{
+ GoPackagePath: reflect.TypeOf(x{}).PkgPath(),
+ RawDescriptor: file_app_proto_rawDesc,
+ NumEnums: 1,
+ NumMessages: 4,
+ NumExtensions: 0,
+ NumServices: 0,
+ },
+ GoTypes: file_app_proto_goTypes,
+ DependencyIndexes: file_app_proto_depIdxs,
+ EnumInfos: file_app_proto_enumTypes,
+ MessageInfos: file_app_proto_msgTypes,
+ }.Build()
+ File_app_proto = out.File
+ file_app_proto_rawDesc = nil
+ file_app_proto_goTypes = nil
+ file_app_proto_depIdxs = nil
+}
diff --git a/_examples/compression_playground/apppb/app.proto b/_examples/compression_playground/apppb/app.proto
new file mode 100644
index 00000000..44a697e6
--- /dev/null
+++ b/_examples/compression_playground/apppb/app.proto
@@ -0,0 +1,35 @@
+syntax = "proto3";
+
+package centrifugal.centrifuge.examples.compression_playground;
+
+option go_package = "./;apppb";
+
+enum EventType {
+ UNKNOWN = 0; // Default value, should not be used
+ GOAL = 1;
+ YELLOW_CARD = 2;
+ RED_CARD = 3;
+ SUBSTITUTE = 4;
+}
+
+message Event {
+ EventType type = 1;
+ int32 minute = 2;
+}
+
+message Player {
+ string name = 1;
+ repeated Event events = 2;
+}
+
+message Team {
+ string name = 1;
+ int32 score = 2;
+ repeated Player players = 3;
+}
+
+message Match {
+ int32 id = 1;
+ Team home_team = 2;
+ Team away_team = 3;
+}
diff --git a/_examples/compression_playground/apppb/generate.sh b/_examples/compression_playground/apppb/generate.sh
new file mode 100755
index 00000000..5d641f55
--- /dev/null
+++ b/_examples/compression_playground/apppb/generate.sh
@@ -0,0 +1,13 @@
+#!/bin/bash
+
+# go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
+# go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
+
+set -e
+
+DST_DIR=./
+
+protoc -I ./ \
+ app.proto \
+ --go_out=${DST_DIR} \
+ --go-grpc_out=${DST_DIR}
diff --git a/_examples/compression_playground/main.go b/_examples/compression_playground/main.go
new file mode 100644
index 00000000..f66e31bd
--- /dev/null
+++ b/_examples/compression_playground/main.go
@@ -0,0 +1,301 @@
+package main
+
+import (
+ "context"
+ "html/template"
+ "log"
+ "math/rand"
+ "net/http"
+ "strings"
+ "time"
+
+ "github.com/centrifugal/centrifuge/_examples/compression_playground/apppb"
+
+ "github.com/centrifugal/centrifuge"
+ "google.golang.org/protobuf/encoding/protojson"
+ "google.golang.org/protobuf/proto"
+)
+
+func simulateMatch(ctx context.Context, num int32, node *centrifuge.Node, useProtobufPayload bool) {
+ // Predefined lists of player names for each team.
+ playerNamesTeamA := []string{"John Doe", "Jane Smith", "Alex Johnson", "Chris Lee", "Pat Kim", "Sam Morgan", "Jamie Brown", "Casey Davis", "Morgan Garcia", "Taylor White", "Jordan Martinez"}
+ playerNamesTeamB := []string{"Robin Wilson", "Drew Taylor", "Jessie Bailey", "Casey Flores", "Jordan Walker", "Charlie Green", "Alex Adams", "Morgan Thompson", "Taylor Clark", "Jordan Hernandez", "Jamie Lewis"}
+
+ // Example setup
+ match := &apppb.Match{
+ Id: num,
+ HomeTeam: &apppb.Team{
+ Name: "Real Madrid",
+ Players: assignNamesToPlayers(playerNamesTeamA),
+ },
+ AwayTeam: &apppb.Team{
+ Name: "Barcelona",
+ Players: assignNamesToPlayers(playerNamesTeamB),
+ },
+ }
+
+ totalSimulationTime := 1 // Total time for the simulation in seconds
+ totalEvents := 30 // Total number of events to simulate
+ eventInterval := float64(totalSimulationTime) / float64(totalEvents) // Time between events
+
+ r := rand.New(rand.NewSource(37))
+
+ for i := 0; i < totalEvents; i++ {
+ // Sleep between events
+ select {
+ case <-ctx.Done():
+ return
+ case <-time.After(time.Duration(eventInterval*1000) * time.Millisecond):
+ }
+
+ // Calculate minute based on event occurrence.
+ minute := int(float64(i) * eventInterval / float64(totalSimulationTime) * 90)
+ eventType := chooseRandomEventType(r)
+ team := chooseRandomTeam(r, match)
+ playerIndex := r.Intn(11) // Choose one of the 11 players randomly
+
+ event := &apppb.Event{Type: eventType, Minute: int32(minute)}
+ team.Players[playerIndex].Events = append(team.Players[playerIndex].Events, event)
+
+ if eventType == apppb.EventType_GOAL {
+ team.Score++
+ }
+
+ var data []byte
+ var err error
+
+ if useProtobufPayload {
+ data, err = proto.Marshal(match)
+ } else {
+ data, err = protojson.MarshalOptions{
+ UseProtoNames: false,
+ }.Marshal(match)
+ }
+ if err != nil {
+ log.Fatal(err)
+ }
+ ch := "match:js:1"
+ if useProtobufPayload {
+ ch = "match:pb:1"
+ }
+ _, err = node.Publish(
+ ch, data,
+ centrifuge.WithDelta(true),
+ centrifuge.WithHistory(10, time.Minute),
+ )
+ if err != nil {
+ log.Fatal(err)
+ }
+ }
+}
+
+func chooseRandomEventType(r *rand.Rand) apppb.EventType {
+ events := []apppb.EventType{
+ apppb.EventType_GOAL, apppb.EventType_YELLOW_CARD, apppb.EventType_RED_CARD, apppb.EventType_SUBSTITUTE}
+ return events[r.Intn(len(events))]
+}
+
+func chooseRandomTeam(r *rand.Rand, match *apppb.Match) *apppb.Team {
+ if r.Intn(2) == 0 {
+ return match.HomeTeam
+ }
+ return match.AwayTeam
+}
+
+// Helper function to create players with names from a given list
+func assignNamesToPlayers(names []string) []*apppb.Player {
+ var players [11]*apppb.Player
+ for i, name := range names {
+ players[i] = &apppb.Player{Name: name}
+ }
+ return players[:]
+}
+
+func auth(h http.Handler) http.Handler {
+ return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+ ctx := r.Context()
+ // Put authentication Credentials into request Context.
+ // Since we don't have any session backend here we simply
+ // set user ID as empty string. Users with empty ID called
+ // anonymous users, in real app you should decide whether
+ // anonymous users allowed to connect to your server or not.
+ cred := ¢rifuge.Credentials{
+ UserID: "",
+ Info: []byte(r.URL.RawQuery), // This is a hack for the playground.
+ }
+ newCtx := centrifuge.SetCredentials(ctx, cred)
+ r = r.WithContext(newCtx)
+ h.ServeHTTP(w, r)
+ })
+}
+
+func main() {
+ // Node is the core object in Centrifuge library responsible for
+ // many useful things. For example Node allows publishing messages
+ // into channels with its Publish method. Here we initialize Node
+ // with Config which has reasonable defaults for zero values.
+ node, err := centrifuge.New(centrifuge.Config{
+ LogLevel: centrifuge.LogLevelDebug,
+ LogHandler: func(entry centrifuge.LogEntry) {
+ log.Println(entry.Message, entry.Fields)
+ },
+ //GetChannelMediumOptions: func(channel string) (centrifuge.ChannelMediumOptions, bool) {
+ // return centrifuge.ChannelMediumOptions{
+ // KeepLatestPublication: true,
+ // EnableQueue: true,
+ // BroadcastDelay: 500 * time.Millisecond,
+ // }, true
+ //},
+ })
+ if err != nil {
+ log.Fatal(err)
+ }
+
+ //redisShardConfigs := []centrifuge.RedisShardConfig{
+ // {Address: "localhost:6379"},
+ //}
+ //var redisShards []*centrifuge.RedisShard
+ //for _, redisConf := range redisShardConfigs {
+ // redisShard, err := centrifuge.NewRedisShard(node, redisConf)
+ // if err != nil {
+ // log.Fatal(err)
+ // }
+ // redisShards = append(redisShards, redisShard)
+ //}
+ //
+ //broker, err := centrifuge.NewRedisBroker(node, centrifuge.RedisBrokerConfig{
+ // // And configure a couple of shards to use.
+ // Shards: redisShards,
+ //})
+ //if err != nil {
+ // log.Fatal(err)
+ //}
+ //node.SetBroker(broker)
+
+ node.OnConnecting(func(ctx context.Context, event centrifuge.ConnectEvent) (centrifuge.ConnectReply, error) {
+ cred, _ := centrifuge.GetCredentials(ctx)
+ reply := centrifuge.ConnectReply{}
+ if strings.Contains(string(cred.Info), "delay") {
+ reply.MaxMessagesInFrame = -1
+ reply.WriteDelay = 200 * time.Millisecond
+ reply.ReplyWithoutQueue = true
+ }
+ return reply, nil
+ })
+
+ // Set ConnectHandler called when client successfully connected to Node.
+ // Your code inside a handler must be synchronized since it will be called
+ // concurrently from different goroutines (belonging to different client
+ // connections). See information about connection life cycle in library readme.
+ // This handler should not block – so do minimal work here, set required
+ // connection event handlers and return.
+ node.OnConnect(func(client *centrifuge.Client) {
+ // In our example transport will always be Websocket but it can be different.
+ transportName := client.Transport().Name()
+ // In our example clients connect with JSON protocol but it can also be Protobuf.
+ transportProto := client.Transport().Protocol()
+ log.Printf("client connected via %s (%s)", transportName, transportProto)
+
+ var useProtobufPayload bool
+ if strings.Contains(string(client.Info()), "protobuf") {
+ useProtobufPayload = true
+ }
+
+ go func() {
+ log.Printf("using protobuf payload: %v", useProtobufPayload)
+ simulateMatch(client.Context(), 0, node, useProtobufPayload)
+ }()
+
+ // Set SubscribeHandler to react on every channel subscription attempt
+ // initiated by a client. Here you can theoretically return an error or
+ // disconnect a client from a server if needed. But here we just accept
+ // all subscriptions to all channels. In real life you may use a more
+ // complex permission check here. The reason why we use callback style
+ // inside client event handlers is that it gives a possibility to control
+ // operation concurrency to developer and still control order of events.
+ client.OnSubscribe(func(e centrifuge.SubscribeEvent, cb centrifuge.SubscribeCallback) {
+ log.Printf("client subscribes on channel %s", e.Channel)
+ cb(centrifuge.SubscribeReply{
+ Options: centrifuge.SubscribeOptions{
+ EnableRecovery: true,
+ RecoveryMode: centrifuge.RecoveryModeCache,
+ AllowedDeltaTypes: []centrifuge.DeltaType{centrifuge.DeltaTypeFossil},
+ },
+ }, nil)
+ })
+
+ // By default, clients can not publish messages into channels. By setting
+ // PublishHandler we tell Centrifuge that publish from a client-side is
+ // possible. Now each time client calls publish method this handler will be
+ // called and you have a possibility to validate publication request. After
+ // returning from this handler Publication will be published to a channel and
+ // reach active subscribers with at most once delivery guarantee. In our simple
+ // chat app we allow everyone to publish into any channel but in real case
+ // you may have more validation.
+ client.OnPublish(func(e centrifuge.PublishEvent, cb centrifuge.PublishCallback) {
+ log.Printf("client publishes into channel %s: %s", e.Channel, string(e.Data))
+ cb(centrifuge.PublishReply{}, nil)
+ })
+
+ // Set Disconnect handler to react on client disconnect events.
+ client.OnDisconnect(func(e centrifuge.DisconnectEvent) {
+ log.Printf("client disconnected: %d (%s)", e.Code, e.Reason)
+ })
+ })
+
+ // Run node. This method does not block. See also node.Shutdown method
+ // to finish application gracefully.
+ if err := node.Run(); err != nil {
+ log.Fatal(err)
+ }
+
+ // Now configure HTTP routes.
+
+ http.Handle("/connection/websocket/no_compression", auth(centrifuge.NewWebsocketHandler(node, centrifuge.WebsocketConfig{})))
+
+ http.Handle("/connection/websocket/with_compression", auth(centrifuge.NewWebsocketHandler(node, centrifuge.WebsocketConfig{
+ Compression: true,
+ CompressionMinSize: 1,
+ CompressionLevel: 1,
+ })))
+
+ http.HandleFunc("/", serveIndex)
+ http.HandleFunc("/json", serveJsonApp)
+ http.HandleFunc("/protobuf", serveProtobufApp)
+
+ // Serve static files from the /static folder
+ fs := http.FileServer(http.Dir("static"))
+ http.Handle("/static/", http.StripPrefix("/static/", fs))
+
+ log.Printf("Starting server, visit http://localhost:8000")
+ if err := http.ListenAndServe("127.0.0.1:8000", nil); err != nil {
+ log.Fatal(err)
+ }
+}
+
+func serveIndex(w http.ResponseWriter, r *http.Request) {
+ t, err := template.ParseFiles("templates/index.html")
+ if err != nil {
+ http.Error(w, err.Error(), http.StatusInternalServerError)
+ return
+ }
+ _ = t.Execute(w, nil)
+}
+
+func serveJsonApp(w http.ResponseWriter, r *http.Request) {
+ t, err := template.ParseFiles("templates/json.html")
+ if err != nil {
+ http.Error(w, err.Error(), http.StatusInternalServerError)
+ return
+ }
+ _ = t.Execute(w, nil)
+}
+
+func serveProtobufApp(w http.ResponseWriter, r *http.Request) {
+ t, err := template.ParseFiles("templates/protobuf.html")
+ if err != nil {
+ http.Error(w, err.Error(), http.StatusInternalServerError)
+ return
+ }
+ _ = t.Execute(w, nil)
+}
diff --git a/_examples/compression_playground/readme.md b/_examples/compression_playground/readme.md
new file mode 100644
index 00000000..c3d46e30
--- /dev/null
+++ b/_examples/compression_playground/readme.md
@@ -0,0 +1,37 @@
+This is a sample simulation of football match where the entire state is sent into WebSocket connection upon every
+match event. The example is not very idiomatic because we try to simulate various modes thus several different
+files were required. In practice, you will have JSON or Protobuf case only, and there is no need to tweak behaviour
+over URL params like we do here.
+
+The goal was to compare different compression strategies for WebSocket data transfer. Please note, that results
+depend a lot on the data you send. You may get absolutely different results for your data. Still we hope this
+example gives some insights on how to choose the best compression strategy and what to expect from Centrifuge.
+
+Results with different configurations for total data sent over the interface from server to client,
+caught with WireShark filter:
+
+```
+tcp.srcport == 8000 && websocket
+```
+
+| Protocol | Compression | Delta | Bytes sent | Percentage |
+|------------------------------|-------------|-----------|------------|------------|
+| JSON over JSON | No | No | 40251 | 100.0 |
+| JSON over JSON | Yes | No | 15669 | 38.93 |
+| JSON over JSON | No | Yes | 6043 | 15.01 |
+| JSON over JSON | Yes | Yes | 5360 | 13.32 |
+| JSON over Protobuf | No | No | 39180 | 97.34 |
+| JSON over Protobuf | Yes | No | 15542 | 38.61 |
+| JSON over Protobuf | No | Yes | 4287 | 10.65 |
+| JSON over Protobuf | Yes | Yes | 4126 | 10.25 |
+| Protobuf over Protobuf | No | No | 16562 | 41.15 |
+| Protobuf over Protobuf | Yes | No | 13115 | 32.58 |
+| Protobuf over Protobuf | No | Yes | 4382 | 10.89 |
+| Protobuf over Protobuf | Yes | Yes | 4473 | 11.11 |
+| JSON over JSON 200ms | Yes | Yes | 2060 | 5.12 |
+| JSON over Protobuf 200ms | Yes | Yes | 2008 | 4.99 |
+| Protobuf over Protobuf 200ms | Yes | Yes | 2315 | 5.75 |
+
+Note: since we send JSON over Protobuf, the JSON size is the same as the JSON over JSON case.
+In this case Centrifugal protocol gives lower overhead, but the main part comes from the JSON payload size.
+Another advantage of JSON over Protobuf is that we are not forced to use base64 encoding for delta case.
diff --git a/_examples/compression_playground/static/app.css b/_examples/compression_playground/static/app.css
new file mode 100644
index 00000000..d3a83b95
--- /dev/null
+++ b/_examples/compression_playground/static/app.css
@@ -0,0 +1,48 @@
+html, body {
+ height: 100%;
+ margin: 0;
+ display: flex;
+ justify-content: center;
+ align-items: center;
+ font-family: 'Arial', sans-serif;
+ background-color: #f0f0f0;
+ color: #333;
+}
+
+#app {
+ width: 100%;
+ max-width: 800px; /* Larger width for better display of big elements */
+ padding: 40px;
+ box-shadow: 0 8px 16px rgba(0, 0, 0, 0.2);
+ background-color: white;
+ border-radius: 10px;
+ margin: 20px;
+}
+
+#app li {
+ margin-bottom: 5px;
+}
+
+#app h2 {
+ font-size: 36px; /* Larger heading */
+ color: #444;
+ margin-bottom: 30px;
+}
+
+#app p {
+ font-size: 28px; /* Larger font size for the scores */
+ line-height: 1.6;
+ margin: 20px 0;
+ color: #555;
+}
+
+/* Styling for team names to make them stand out */
+#app p span.team-name {
+ font-weight: bold;
+}
+
+/* Making the scores pop out even more */
+#app p span.team-score {
+ color: #d9534f; /* A vibrant color for the scores */
+ font-weight: bold;
+}
\ No newline at end of file
diff --git a/_examples/compression_playground/static/app.proto b/_examples/compression_playground/static/app.proto
new file mode 100644
index 00000000..44a697e6
--- /dev/null
+++ b/_examples/compression_playground/static/app.proto
@@ -0,0 +1,35 @@
+syntax = "proto3";
+
+package centrifugal.centrifuge.examples.compression_playground;
+
+option go_package = "./;apppb";
+
+enum EventType {
+ UNKNOWN = 0; // Default value, should not be used
+ GOAL = 1;
+ YELLOW_CARD = 2;
+ RED_CARD = 3;
+ SUBSTITUTE = 4;
+}
+
+message Event {
+ EventType type = 1;
+ int32 minute = 2;
+}
+
+message Player {
+ string name = 1;
+ repeated Event events = 2;
+}
+
+message Team {
+ string name = 1;
+ int32 score = 2;
+ repeated Player players = 3;
+}
+
+message Match {
+ int32 id = 1;
+ Team home_team = 2;
+ Team away_team = 3;
+}
diff --git a/_examples/compression_playground/templates/index.html b/_examples/compression_playground/templates/index.html
new file mode 100644
index 00000000..18f1366d
--- /dev/null
+++ b/_examples/compression_playground/templates/index.html
@@ -0,0 +1,59 @@
+
+
+
+
+
+
+
+
+
+
+ -
+ JSON over JSON, no compression, no delta
+
+ -
+ JSON over JSON, with compression, no delta
+
+ -
+ JSON over JSON, no compression, with delta
+
+ -
+ JSON over JSON, with compression, with delta
+
+ -
+ JSON over Protobuf, no compression, no delta
+
+ -
+ JSON over Protobuf, with compression, no delta
+
+ -
+ JSON over Protobuf, no compression, with delta
+
+ -
+ JSON over Protobuf, with compression, with delta
+
+ -
+ Protobuf over Protobuf, no compression, no delta
+
+ -
+ Protobuf over Protobuf, with compression, no delta
+
+ -
+ Protobuf over Protobuf, no compression, with delta
+
+ -
+ Protobuf over Protobuf, with compression, with delta
+
+ -
+ JSON over JSON, with compression, with delta, with delay
+
+ -
+ JSON over Protobuf, with compression, with delta, with delay
+
+ -
+ Protobuf over Protobuf, with compression, with delta, with delay
+
+
+