postMessage method

Future<bool> postMessage(String channelName, SerializableModel message, { bool global = false, })

Posts a message to a named channel. Optionally a destinationServerId can be provided, in which case the message is sent only to that specific server within the cluster. If no destinationServerId is provided, the message is passed on to all servers in the cluster.

Returns true if the message was successfully posted.

Throws a StateError if Redis is not enabled and global is set to true.

Implementation

Future<bool> postMessage(
  String channelName,
  SerializableModel message, {
  bool global = false,
}) async {
  if (global) {
    // Send to Redis
    var data =
        Serverpod.instance.serializationManager.encodeWithType(message);
    var redisController = Serverpod.instance.redisController;
    if (redisController == null) {
      throw StateError('Redis needs to be enabled to use this method');
    }

    return await redisController.publish(channelName, data);
  } else {
    // Handle internally in this server instance
    var channel = _channels[channelName];
    if (channel == null) return true;

    for (var callback in channel.toList()) {
      callback(message);
    }
    return true;
  }
}