package net.sf.atmodem4j.core;
   
   /*
    * #%L
    * ATModem4J Core
    * %%
    * Copyright (C) 2009 - 2014 atmodem4j
    * %%
    * atmodem4j - Drivers for the AT modem - http://atmodem4j.sourceforge.net/
   * Copyright (C) 2009-2014, atmodem4j.sf.net, and individual contributors as indicated
   * by the @authors tag. See the copyright.txt in the distribution for a
   * full listing of individual contributors.
   * 
   * This is free software; you can redistribute it and/or modify it
   * under the terms of the GNU General Public License as
   * published by the Free Software Foundation; either version 3 of
   * the License, or (at your option) any later version.
   * 
   * This software is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
   * Lesser General Public License for more details.
   * 
   * You should have received a copy of the GNU Lesser General Public
   * License along with this software; if not, write to the Free
   * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
   * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
   * #L%
   */
  
  import java.io.IOException;
  import java.io.InputStream;
  import java.io.OutputStream;
  import net.sf.atmodem4j.core.fax.FaxExtention;
  import net.sf.atmodem4j.core.gsm.GsmExtention;
  import net.sf.atmodem4j.core.parser.Parser;
  import net.sf.atmodem4j.core.parser.ResultCodeToken;
  import net.sf.atmodem4j.core.voice.VoiceExtention;
  
  /**
   * Main Interface that encapsulates the real modem implementation.
   *
   * @author aploese
   */
  public interface Modem {
  
      /**
       * Clrl+Z for finishing prompt (gsm sm useage) also known as end of file.
       */
      static final char EOF = (char) 0x1A;
  
      enum ModemCapabilities {
          Data, Voice, Fax, Gsm;
  
          static ModemCapabilities[] parseCapabilities(String extractLineData) {
              throw new UnsupportedOperationException("Not yet implemented");
          }
      }
  
      /**
       * The state of the modem
       */
      enum CallState {
  
          Idle, DialPending, AnswerPending, callEstablished;
      };
  
      /**
       * The default time
       * @return
       */
      int getDefaultWaitTime();
  
      int getDefaultTrys();
  
      boolean isIdle();
  
      void garbageCollected(Parser parser, String s);
  
      void parsedResultCode(Parser parser, ResultCodeToken r);
  
      void parsedPrompt(Parser parser);
  
      void parsedRing(Parser parser);
  
      boolean init() throws IOException, InterruptedException;
  
      boolean init(String... initStrings) throws IOException, InterruptedException;
  
      void removeIncommingCallHandler(CallHandler callHandler);
  
      void setIncommingCallHandler(CallHandler callHandler) throws
              IOException,
              InterruptedException;
  
      boolean sendAndWaitForOK(String cmdLine) throws IOException,
              InterruptedException;
  
      boolean sendAndWaitForOK(String cmdLine, int trys, int waitTime)
             throws IOException, InterruptedException;
 
     boolean sendCommandLineWithPrompt(String command, String data) throws IOException, InterruptedException;
 
     String[] sendAndEctractData(String cmdLine) throws IOException,
             InterruptedException;
 
     String[] sendAndEctractData(String cmdLine, int trys, int waitTime)
             throws IOException, InterruptedException;
 
     void setRingListener(RingListener ringListener);
 
     void setModemInputStream(InputStream inputStream);
 
     void setModemOutputStream(OutputStream outputStream);
 
     boolean isGsmExtention();
 
     boolean isVoiceExtention();
 
     boolean isFaxExtention();
 
     GsmExtention getGsmExtention();
 
     void setGsmExtention(GsmExtention gsmExtention);
 
     VoiceExtention getVoiceExtention();
 
     void setVoiceExtention(VoiceExtention voiceExtention);
 
     FaxExtention getFaxExtention();
 
     void setFaxExtention(FaxExtention faxExtention);
 
     Connection dial(String number) throws IOException,
             InterruptedException;
 
     void dial(String number, CallHandler waitingOutgoingCall)
             throws
             IOException,
             InterruptedException;
 
     void setSpeaker();
 
     boolean reset() throws IOException, InterruptedException;
 
     String getAutomaticAnswer() throws IOException, InterruptedException;
 
     String getCommandLineTerminationCharacter() throws IOException,
             InterruptedException;
 
     String getResponseFormattingChar() throws IOException,
             InterruptedException;
 
     String getCommandLineEditingChar() throws IOException,
             InterruptedException;
 
     String getModulationSelection() throws IOException,
             InterruptedException;
 
     String getManufacturerId() throws IOException, InterruptedException;
 
     String getModelId() throws IOException, InterruptedException;
 
     String getRevisionId() throws IOException, InterruptedException;
 
     String getSerialNumber() throws IOException, InterruptedException;
 
     String getObjectId() throws IOException, InterruptedException;
 
     ModemCapabilities[] getCapabilities() throws IOException, InterruptedException;
 
     String getCountryOfInstallation() throws IOException,
             InterruptedException;
 
     void setInitStrings(String... initStrings);
 
     String[] getInitStrings();
 
     boolean hangUp() throws IOException, InterruptedException;
 
     boolean close();
 
     void reenterDataMode();
     
     String extractData(String data);
 
 }