Class AckExtension

  • All Implemented Interfaces:
    org.cometd.bayeux.client.ClientSession.Extension

    public class AckExtension
    extends org.cometd.bayeux.client.ClientSession.Extension.Adapter

    This client-side extension enables the client to acknowledge to the server the messages that the client has received.

    For the acknowledgement to work, the server must be configured with the correspondent server-side ack extension. If both client and server support the ack extension, then the ack functionality will take place automatically. By enabling this extension, all messages arriving from the server will arrive via the long poll, so the comet communication will be slightly chattier. The fact that all messages will return via long poll means also that the messages will arrive with total order, which is not guaranteed if messages can arrive via both long poll and normal response. Messages are not acknowledged one by one, but instead a group of messages is acknowledged when long poll returns.

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface org.cometd.bayeux.client.ClientSession.Extension

        org.cometd.bayeux.client.ClientSession.Extension.Adapter
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ACK_FIELD  
    • Constructor Summary

      Constructors 
      Constructor Description
      AckExtension()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean rcvMeta​(org.cometd.bayeux.client.ClientSession session, org.cometd.bayeux.Message.Mutable message)  
      boolean sendMeta​(org.cometd.bayeux.client.ClientSession session, org.cometd.bayeux.Message.Mutable message)  
      • Methods inherited from class org.cometd.bayeux.client.ClientSession.Extension.Adapter

        rcv, send
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • AckExtension

        public AckExtension()
    • Method Detail

      • rcvMeta

        public boolean rcvMeta​(org.cometd.bayeux.client.ClientSession session,
                               org.cometd.bayeux.Message.Mutable message)
        Specified by:
        rcvMeta in interface org.cometd.bayeux.client.ClientSession.Extension
        Overrides:
        rcvMeta in class org.cometd.bayeux.client.ClientSession.Extension.Adapter
      • sendMeta

        public boolean sendMeta​(org.cometd.bayeux.client.ClientSession session,
                                org.cometd.bayeux.Message.Mutable message)
        Specified by:
        sendMeta in interface org.cometd.bayeux.client.ClientSession.Extension
        Overrides:
        sendMeta in class org.cometd.bayeux.client.ClientSession.Extension.Adapter