packetcable-driver/src/main/java/org/pcmm/gates/IGateUsageInfo.java

   1 /*
   2  * Copyright (c) 2015 CableLabs 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
   9 package org.pcmm.gates;
  10
  11 import org.pcmm.base.IPCMMBaseObject;
  12
  13 /**
  14  *
  15  * From the Packetcable Multimedia specification section 6.4.2.13
  16  *
  17  * The Gate Usage Info object contains a counter indicating the number of kilobytes transmitted
  18  * over this Gate.
  19  */
  20 public interface IGateUsageInfo extends IPCMMBaseObject {
  21
  22     /**
  23      * The S-Type for Gate Time Info
  24      */
  25     byte STYPE = 1;
  26
  27
  28     /**
  29      * Time Committed total amount of time the Gate has been in the Committed and Committed
  30      * Recovery states
  31      *
  32      * @return usage in kbps;
  33      */
  34    long getGateUsageInfo();
  35 }