core/src/main/java/flex/messaging/client/AsyncPollHandler.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package flex.messaging.client;

/**
 * Defines the interface to handle asynchronous poll results.
 */
public interface AsyncPollHandler
{
    /**
     * Invoked by the <tt>FlexClient</tt> when an asynchronous poll result is available.
     * 
     * @param flushResult The flush result containing messages to return in the poll response and
     *         an optional wait time before the client should issue its next poll.
     */
    void asyncPollComplete(FlushResult flushResult);
}