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 /**
  13  * Request context handles all requests on device. Number of requests is limited by request quota. When this quota is
  14  * exceeded all rpc's will end up with exception.
  15  * <p>
  16  * Created by Martin Bobak &lt;mbobak@cisco.com&gt; on 25.2.2015.
  17  */
  18 public interface RequestContext<T> extends RequestFutureContext<T>, AutoCloseable {
  19
  20     /**
  21      * Returns xid generated for this request.
  22      *
  23      * @return
  24      */
  25     Xid getXid();
  26
  27     /**
  28      * Sets xid generated for this request.
  29      */
  30     void setXid(Xid xid);
  31
  32     /**
  33      * Returns request timeout value.
  34      *
  35      * @return
  36      */
  37     long getWaitTimeout();
  38
  39
  40     /**
  41      * Sets request timeout value.
  42      */
  43     void setWaitTimeout(long waitTimeout);
  44
  45     @Override
  46     void close();
  47 }