Skip to content

Add Objects flags, channel modes and message types #298

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Apr 17, 2025
Merged

Add Objects flags, channel modes and message types #298

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
fc87dcc
Add new protocol message flags, actions, channel modes, message types…
VeskeR Mar 25, 2025
557af83
Update API docstrings for new Objects ChannelModes and ChannelMetrics
VeskeR Mar 20, 2025
e2df05e
Clarify that `ObjectState.map` and `ObjectState.counter` do not inclu…
VeskeR Mar 27, 2025
26973b7
Fix spec point for OBJECT_SUBSCRIBE and OBJECT_PUBLISH
VeskeR Apr 17, 2025
b7b47db
Add OBJECT to RTN7a
VeskeR Apr 17, 2025
f9fdda8
Reserve spec points for Objects spec
VeskeR Apr 17, 2025
f458064
Bump specification version to 3.1.0
VeskeR Apr 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion meta.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
versions:
# Must conform to Semantic Versioning (https://semver.org/).
# Should never need to use a pre-release suffix.
specification: 3.0.1
specification: 3.1.0

# Must be an Integer value.
# Previously, prior to version 2 (i.e. versions 0.8, 1.0, 1.1 and 1.2) it was a Decimal value.
Expand Down
4 changes: 4 additions & 0 deletions textile/api-docstrings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -418,6 +418,8 @@ Describes the possible flags used to configure client capabilities, using [`Chan
| PUBLISH || The client can publish messages. |
| SUBSCRIBE || The client can subscribe to messages. |
| PRESENCE_SUBSCRIBE || The client can receive presence messages. |
| OBJECT_PUBLISH || The client can publish object messages. |
| OBJECT_SUBSCRIBE || The client can receive object messages. |

## class ChannelStateChange

Expand Down Expand Up @@ -492,6 +494,8 @@ Contains the metrics associated with a [`RestChannel`]{@link RestChannel} or [`R
| presenceSubscribers: Int ||| CHM2d | The number of realtime attachments receiving presence messages on the channel. This requires the `subscribe` capability and for a client to not have specified a [`ChannelMode`]{@link ChannelMode} flag that excludes [`PRESENCE_SUBSCRIBE`]{@link ChannelMode#PRESENCE_SUBSCRIBE}. |
| publishers: Int ||| CHM2e | The number of realtime attachments permitted to publish messages to the channel. This requires the `publish` capability and for a client to not have specified a [`ChannelMode`]{@link ChannelMode} flag that excludes [`PUBLISH`]{@link ChannelMode#PUBLISH}. |
| subscribers: Int ||| CHM2f | The number of realtime attachments receiving messages on the channel. This requires the `subscribe` capability and for a client to not have specified a [`ChannelMode`]{@link ChannelMode} flag that excludes [`SUBSCRIBE`]{@link ChannelMode#SUBSCRIBE}. |
| objectPublishers: Int ||| CHM2g | The number of realtime attachments permitted to publish object messages to the channel. This requires the `object-publish` capability and for a client to have specified a [`ChannelMode`]{@link ChannelMode} flag that includes [`OBJECT_PUBLISH`]{@link ChannelMode#OBJECT_PUBLISH}. |
| objectSubscribers: Int ||| CHM2h | The number of realtime attachments receiving object messages on the channel. This requires the `object-subscribe` capability and for a client to have specified a [`ChannelMode`]{@link ChannelMode} flag that includes [`OBJECT_SUBSCRIBE`]{@link ChannelMode#OBJECT_SUBSCRIBE}. |

## class CipherParams

Expand Down
Loading
Loading