benchmarks/original_interfaces/GPSGateway.java

   1 package iotcode.interfaces;
   2
   3 //RMI packages
   4 import java.rmi.Remote;
   5 import java.rmi.RemoteException;
   6
   7 // Checker annotations
   8 import iotchecker.qual.NonLocalRemote;
   9
  10 /** Gateway public interface, e.g. for PhoneGateway
  11  *
  12  * @author      Rahmadi Trimananda <rahmadi.trimananda @ uci.edu>
  13  * @version     1.0
  14  * @since       2016-04-27
  15  */
  16
  17 public interface GPSGateway extends Remote {
  18
  19         /** Method to start the gateway.
  20          *
  21          *   @param None.
  22          *
  23          *   @return None
  24          */
  25         public void start() throws RemoteException;
  26
  27
  28         /** Method to stop the gateway.
  29          *
  30          *   @param None.
  31          *
  32          *   @return None
  33          */
  34         public void stop() throws RemoteException;
  35
  36
  37         /** Method to initialize the gateway.
  38          *
  39          *   @return [void] None.
  40          */
  41         public void init() throws RemoteException;
  42
  43
  44         /** Register an object to retrieve callbacks when new data is available.
  45          *
  46          *   @param _callbackTo [PhoneGatewayCallback].
  47          *
  48          *   @return [void] None.
  49          */
  50         public void registerCallback(@NonLocalRemote GPSGatewayCallback _callbackTo) throws RemoteException;
  51
  52
  53         /** Get room identifier
  54          *
  55          *   @param None.
  56          *
  57          *   @return [int] Room identifier.
  58          */
  59         public int getRoomID() throws RemoteException;
  60
  61
  62         /** Get ring status
  63          *
  64          *   @param None.
  65          *
  66          *   @return [boolean] Ring status (true/false).
  67          */
  68         public boolean getRingStatus() throws RemoteException;
  69
  70         /** Set boolean of new room identifier availability
  71          *
  72          *   @param [boolean] Room identifier availability (true if there is new room ID)
  73          *
  74          *   @return [void] None.
  75          */
  76         public void setNewRoomIDAvailable(boolean bValue) throws RemoteException;
  77
  78         /** Set boolean of new ring status availability
  79          *
  80          *   @param [boolean] Ring status availability (true if there is new ring status)
  81          *
  82          *   @return [void] None.
  83          */
  84         public void setNewRingStatusAvailable(boolean bValue) throws RemoteException;
  85 }
  86
  87
  88
  89
  90
  91
  92
  93
  94
  95
  96
  97
  98
  99