/*
 * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */

package org.opendaylight.openflowplugin.api.openflow.device;

import com.google.common.util.concurrent.ListenableFuture;
import io.netty.util.Timeout;
import java.math.BigInteger;
import java.util.List;
import javax.annotation.Nonnull;
import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
import org.opendaylight.openflowplugin.api.openflow.OFPContext;
import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceReplyProcessor;
import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
import org.opendaylight.openflowplugin.api.openflow.lifecycle.LifecycleService;
import org.opendaylight.openflowplugin.api.openflow.registry.ItemLifeCycleRegistry;
import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.SalRoleService;
import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.SetRoleOutput;
import org.opendaylight.yangtools.yang.common.RpcResult;

/**
 * The central entity of OFP is the Device Context, which encapsulate the logical state of a switch
 * as seen by the controller. Each OpenFlow session is tracked by a Connection Context.
 * These attach to a particular Device Context in such a way, that there is at most one primary
 * session associated with a Device Context. Whenever the controller needs to interact with a
 * particular switch, it will do so in the context of the calling thread, obtaining a lock on
 * the corresponding Device Context – thus the Device Context becomes the fine-grained point
 * of synchronization. The only two entities allowed to send requests towards the switch are
 * Statistics Manager and RPC Manager. Each of them allocates a Request Context for interacting
 * with a particular Device Context. The Request Contexts are the basic units of fairness,
 * which is enforced by keeping a cap on the number of outstanding requests a particular Request
 * Context can have at any point in time. Should this quota be exceeded, any further attempt to make
 * a request to the switch will fail immediately, with proper error indication.
 */
public interface DeviceContext extends
        OFPContext,
        DeviceReplyProcessor,
        TxFacade,
        DeviceRegistry,
        RequestContextStack {

    /**
     * Method close all auxiliary connections and primary connection.
     */
    void shutdownConnection();

    /**
     * Method add auxiliary connection contexts to this context representing single device connection.
     * @param connectionContext new connection context
     */
    void addAuxiliaryConnectionContext(ConnectionContext connectionContext);

    /**
     * Method removes auxiliary connection context from this context representing single device connection.
     * @param connectionContext connection which need to be removed
     */
    void removeAuxiliaryConnectionContext(ConnectionContext connectionContext);

    /**
     * Method provides state of device represented by this device context.
     *
     * @return {@link DeviceState}
     */
    DeviceState getDeviceState();

    /**
     * Method has to close TxManager ASAP we are notified about Closed Connection.
     * @return sync. future for Slave and MD-SAL completition for Master
     */
    ListenableFuture<Void> shuttingDownDataStoreTransactions();

    /**
     * Getter.
     * @return current devices connection context
     */
    ConnectionContext getPrimaryConnectionContext();

    /**
     * Getter.
     * @return current devices auxiliary connection contexts
     */
    ConnectionContext getAuxiliaryConnectionContexts(BigInteger cookie);


    /**
     * Getter.
     * @return translator library
     */
    TranslatorLibrary oook();

    /**
     * store cancellable timeout handler of currently running barrier task.
     */
    void setCurrentBarrierTimeout(Timeout timeout);

    /**
     * Getter.
     * @return cancellable timeout handle of currently running barrier task
     */
    Timeout getBarrierTaskTimeout();

    void setNotificationPublishService(NotificationPublishService notificationPublishService);

    MessageSpy getMessageSpy();

    <T extends OfHeader> MultiMsgCollector<T> getMultiMsgCollector(final RequestContext<List<T>> requestContext);

    /**
     * indicates that device context is fully published (e.g.: packetIn messages should be passed).
     */
    void onPublished();

    /**
     * change packetIn rate limiter borders.
     * @param upperBound max amount of outstanding packetIns
     */
    void updatePacketInRateLimit(long upperBound);

    /**
     * Getter.
     * @return registry point for item life cycle sources of device
     */
    ItemLifeCycleRegistry getItemLifeCycleSourceRegistry();

    void setSwitchFeaturesMandatory(boolean switchFeaturesMandatory);

    void putLifecycleServiceIntoTxChainManager(LifecycleService lifecycleService);

    boolean isSkipTableFeatures();

    /**
     * Setter for sal role service.
     * @param salRoleService Role Service
     */
    void setSalRoleService(@Nonnull final SalRoleService salRoleService);

    /**
     * Make device slave.
     * @return listenable future from sal role service
     */
    ListenableFuture<RpcResult<SetRoleOutput>> makeDeviceSlave();

    boolean canUseSingleLayerSerialization();
}