dart_pusher_channels 1.0.0

dart_pusher_channels: ^1.0.0 copied to clipboard

Whole the project has been rethinked and redesigned in this update. The structure is more convenient and canonical according to the official documentation

NEW FEATURES:

• Support for Presence Channels
• Triggering events

BREAKING CHANGES:

Refactored:

• Renamed and reorganized a hierarchy of the event classes
• Reorganized a hierarchy of the channel classes
• Divided the whole lifecycle of the client in separate layers:
  • Connection layer
    • Channels layer
    • Client's layer

Removed:

• ConnectionDelegate
• WebSocketChannelConnectionDelegate
• TokenAuthorizationDelegate
• Event
• ReadEvent
• SendEvent

Added:

• Unit tests
• PusherChannelsConnection - interface for a connection layer
• PusherChannelsWebSocketConnection - implementation of PusherChannelsConnection
• PusherChannelsClientLifeCycleController - internal controller of a client's lifecycle
• ChannelsManager - internal delegate of channels
• ChannelMembers
• ChannelExtension
• TriggerableChannelMixin
• EndpointAuthorizableChannel
• EndpointAuthorizableChannelAuthorizationDelegate
• PresenceChannel

Updated kDartPusherChannelsLibraryVersion constant metadata to 0.3.1

Added shouldSupplyQueryMetaData to PusherChannelsOptions. It will regulate whether to include or omit the metadata such as client, version, protocol.

BREAKING CHANGE: PusherChannelOptions was deprecated and renamed to PusherChannelsOptions for conveniency.

Returning '/' in path getter of PusherChannelOptions if both key and path parameters are provided as null.

Updated README.md

Minimal changes:

• key parameter of PusherChannelOptions is nullable now.

• Added a feature to set custom endpoint path to PusherChannelOptions with path parameter.

• Made version parameter of PusherChannelOptions equals to kDartPusherChannelsLibraryVersion.

• Updated the inline documentation.

• Updated README.md.

• Update the example file.

Bug fixes:

• Fixed bug when connection status was set to ConnectionStatus.connceted each time the pusher error event occured.

(Even if connection status was set to ConnectionStatus.established before).

• Fixed bug on double connections triggered by concurrent attempts to reconnect.

Internal changes:

• Using disconnectSafely instead of disconnect on disposing the delegate.

• Fixed markdown of README

• Updated inline documentation of the package

• Change: connect and disconnect methods of ConnectionDelegate are @protected. Use connectSafely and disconnectSafely respectively from the outside.

Merging pull requests #6,

#8, #10, #12. Thanks to Nicolas Britos for contributions.

• Added an additional member pingWaitPongDuration to the ConnectionDelegate and the parameter with the same name

to the constructor PusherChannelsClient.websocket. It will regulate timeout of ping waiting for pong (checking if connection is alive).

• Fixed multiple connections occuring after disconnect commited by multiple reconnect calls.

• Distincting manual disconnections of ConnectionDelegate (disconnectSafely) from automated ones.

• Fixed: multiple socket connections while calling connect multiple times are prevented.

• Change: now reconnect's type is Future<void>. (Previously was void).

Featuring contributors in README

Merging pull request #5, many thanks to Nicolas Britos

• Add custom logger handler to use a custom Logger instead of printing to console.

• Hide PusherChannelsPackageLogger from public API.

• Fix logger tests not capturing what was being printed to console.

• Remove logTest method as it is not needed anymore.

Added PusherChannelsPackageConfigs which enables and disables log prints.

Added following additional controls to PusherChannelsClient

• Method disconnect()

• Method reconnect()

• Updated README.md

• Improved annotations

• Tested on Windows succesfully and updated meta data

• Fixed reconnection tries on disposal

• Updated the description of pubspec.yaml

• Fixed issue of non-cancallable timer. Added logging with print by default. Will be optional in next minor version.

• Making refresh callback of onConnectionErrorHandler constructor of PusherChannelsClient.websocket non-nullable

• Implemented unsubscribe method for private channels.

• Updated README.

• Using more canonical names of classes and interfaces.

• Updated README and example.

• Updated documentation.

• Initial version.