openflowplugin-api/src/main/java/org/opendaylight/openflowplugin/api/openflow/device/RequestContext.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.openflowplugin.api.openflow.device;
   9
  10
  11 /**
  12  * Request context handles all requests on device. Number of requests is limited by request quota. When this quota is
  13  * exceeded all rpc's will end up with exception.
  14  * <p>
  15  * Created by Martin Bobak &lt;mbobak@cisco.com&gt; on 25.2.2015.
  16  */
  17 public interface RequestContext<T> extends RequestFutureContext<T>, AutoCloseable {
  18
  19     /**
  20      * Returns xid generated for this request.
  21      *
  22      * @return
  23      */
  24     Xid getXid();
  25
  26     /**
  27      * Sets xid generated for this request.
  28      */
  29     void setXid(Xid xid);
  30
  31     /**
  32      * Returns request timeout value.
  33      *
  34      * @return
  35      */
  36     long getWaitTimeout();
  37
  38
  39     /**
  40      * Sets request timeout value.
  41      */
  42     void setWaitTimeout(long waitTimeout);
  43
  44 }