AsyncSubscription.java

/*
 * Copyright 2016 higherfrequencytrading.com
 *
 * Licensed 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 net.openhft.chronicle.network.connection;

import net.openhft.chronicle.wire.WireIn;
import org.jetbrains.annotations.NotNull;

interface AsyncSubscription {

    /**
     * returns the unique tid that will be used in the subscription, this tid must be unique per
     * socket connection
     *
     * @return the unique tid
     */
    long tid();

    /**
     * Implement this to establish a subscription with the server
     */
    void applySubscribe();

    /**
     * Implement this to consume the subscription
     *
     * @param inWire the wire to write the subscription to
     */
    void onConsumer(@NotNull final WireIn inWire);

    /**
     * called when the socket connection is closed
     */
    void onClose();
}