Package org.cometd.bayeux.server

Interface ServerMessage

  • All Superinterfaces:
    java.util.Map<java.lang.String,​java.lang.Object>, org.cometd.bayeux.Message
    All Known Subinterfaces:
    ServerMessage.Mutable
    public interface ServerMessage
extends org.cometd.bayeux.Message

    Representation of a server side message.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static interface  ServerMessage.Mutable
      The mutable version of a ServerMessage

      • Nested classes/interfaces inherited from interface java.util.Map

        java.util.Map.Entry<K extends java.lang.Object,​V extends java.lang.Object>

    • Field Summary

      • Fields inherited from interface org.cometd.bayeux.Message

        ADVICE_FIELD, CHANNEL_FIELD, CLIENT_ID_FIELD, CONNECTION_TYPE_FIELD, DATA_FIELD, ERROR_FIELD, EXT_FIELD, ID_FIELD, INTERVAL_FIELD, MAX_INTERVAL_FIELD, MIN_VERSION_FIELD, RECONNECT_FIELD, RECONNECT_HANDSHAKE_VALUE, RECONNECT_NONE_VALUE, RECONNECT_RETRY_VALUE, SUBSCRIPTION_FIELD, SUCCESSFUL_FIELD, SUPPORTED_CONNECTION_TYPES_FIELD, TIMEOUT_FIELD, TIMESTAMP_FIELD, TRANSPORT_FIELD, VERSION_FIELD

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      ServerMessage.Mutable getAssociated()  
      BayeuxContext getBayeuxContext()  
      ServerTransport getServerTransport()  
      boolean isLazy()  

      • Methods inherited from interface java.util.Map

        clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

      • Methods inherited from interface org.cometd.bayeux.Message

        getAdvice, getChannel, getChannelId, getClientId, getData, getDataAsMap, getExt, getId, isMeta, isPublishReply, isSuccessful

    • Method Detail

      • getAssociated

        ServerMessage.Mutable getAssociated()
        Returns:
        a message associated with this message on the server. Typically this is a meta message that the current message is being sent in response to.

      • isLazy

        boolean isLazy()
        Returns:
        true if the message is lazy and should not force the session's queue to be flushed

      • getBayeuxContext

        BayeuxContext getBayeuxContext()
        Returns:
        the BayeuxContext associated with this message

      • getServerTransport

        ServerTransport getServerTransport()
        Returns:
        the ServerTransport associated with this message