EchoLink::Qso Class Reference

A class for creating an EchoLink connection. More...

#include <EchoLinkQso.h>

List of all members.

Public Types

• enum State { STATE_DISCONNECTED, STATE_CONNECTING, STATE_BYE_RECEIVED, STATE_CONNECTED }

  The type of the connection state. More...
  

Public Member Functions

• Qso (const Async::IpAddress &ip, const std::string &callsign="", const std::string &name="", const std::string &info="")

  Constructor.
  

• ~Qso (void)

  Destructor.
  

• bool initOk (void)

  Check that the initialization went ok.
  

• bool setLocalCallsign (const std::string &callsign)

  Set the local callsign.
  

• const std::string & localCallsign (void) const

  Retrieve the local callsign.
  

• bool setLocalName (const std::string &name)

  Set the local name (name of station operator).
  

• const std::string & localName (void) const

  Retrieve the local name.
  

• void setLocalInfo (const std::string &info)

  Set the local info.
  

• const std::string & localInfo (void) const

  Retrieve the local station info.
  

• bool connect (void)

  Initiate a connection to the remote station.
  

• bool accept (void)

  Accept an incoming connection.
  

• bool disconnect (void)

  Initiate a disconnection from the remote station.
  

• bool sendInfoData (const std::string &info="")

  Send info data to the remote station.
  

• bool sendChatData (const std::string &msg)

  Send chat data to the remote station.
  

• const Async::IpAddress & remoteIp (void) const

  Get the IP address of the remote station.
  

• int sendAudio (short *buf, int len)

  Send audio to the remote station.
  

• bool sendAudioRaw (GsmVoicePacket *packet)

  Send a raw GSM audio packet to the remote station.
  

• bool flushAudioSendBuffer (void)

  Flush the audio send buffer so that all audio get transmitted.
  

• void setRemoteName (const std::string &name)

  Set the name of the remote station.
  

• const std::string & remoteName (void) const

  Get the remote name.
  

• void setRemoteCallsign (const std::string &call)

  Set the callsign of the remote station.
  

• const std::string & remoteCallsign (void) const

  Get the remote callsign.
  

• bool isRemoteInitiated (void) const

  Find out if the connection is remotely initiated or locally initiated.
  

• bool receivingAudio (void) const

  Find out if there is audio coming in on this connection.
  

Public Attributes

• SigC::Signal1< void, const
  std::string & > infoMsgReceived

  A signal that is emitted when a station info message is received.
  

• SigC::Signal1< void, const
  std::string & > chatMsgReceived

  A signal that is emitted when a chat message is received.
  

• SigC::Signal1< void, State > stateChange

  A signal that is emitted when the connection state changes.
  

• SigC::Signal1< void, bool > isReceiving

  A signal that is emitted when the audio receive state changes.
  

• SigC::Signal2< int, short *,
  int > audioReceived

  A signal that is emitted when an audio datagram has been received.
  

• SigC::Signal1< void, GsmVoicePacket * > audioReceivedRaw

  A signal that is emitted when an audio datagram has been received.
  

Classes

• class GsmVoicePacket

---

Detailed Description

A class for creating an EchoLink connection.

Author:

Tobias Blomberg

Date:

2003-03-11

This class is used to create a connection to another EchoLink node. It only handles outgoing connections. To handle incoming connections, have a look at EchoLink::Dispatcher. However, when an incoming connection has been signalled by the dispatcher, a Qso object should be created to complete the connection. This logic should be glued together in the main program.

For an example usage, have a look at the code below. A connection is created to ourself. When the connection has been established the information message is automatically transmitted. Upon reception of the information message a disconnect is initiated. When the link has been disconnected the application exits.

#include <iostream>
#include <AsyncCppApplication.h>
#include <EchoLinkQso.h>

using namespace std;
using namespace Async;
using namespace EchoLink;

class MyClass : public SigC::Object
{
  public:
    MyClass(void)
    {
      qso = new Qso(IpAddress("127.0.0.1"), "MYCALL", "MyName", "A test Qso");
      if (!qso->initOk())
      {
        delete qso;
        cerr << "Creation of Qso failed\n";
        Application::app().quit();
        return;
      }
      qso->infoMsgReceived.connect(slot(this, &MyClass::onInfoMsgReceived));
      qso->stateChange.connect(slot(this, &MyClass::onStateChange));
      qso->connect();
    }
    
    ~MyClass(void)
    {
      delete qso;
    }
    
  private:
    Qso *qso;
    
    void onInfoMsgReceived(const string& msg)
    {
      cerr << "Info message received: " << msg << endl;
      qso->disconnect();
    }
    
    void onStateChange(Qso::State state)
    {
      cerr << "State changed to ";
      switch (state)
      {
        case Qso::STATE_DISCONNECTED:
          cerr << "DISCONNECTED";
          Application::app().quit();
          break;
        case Qso::STATE_CONNECTING:
          cerr << "CONNECTING";
          break;
        case Qso::STATE_CONNECTED:
          cerr << "CONNECTED";
          break;
        default:
          break;
      }
      cout << endl;
    }
};

int main(int argc, char **argv)
{
  CppApplication app; // or QtApplication
  MyClass my_class;
  app.exec();
}

Definition at line 142 of file EchoLinkQso.h.

---

Member Enumeration Documentation

enum EchoLink::Qso::State

The type of the connection state. Enumerator: STATE_DISCONNECTED  No connection to the remote station. STATE_CONNECTING  Connecting to remote station (not established). STATE_BYE_RECEIVED  Received a disconnect request from remote station. STATE_CONNECTED  Connected to remote station. Definition at line 159 of file EchoLinkQso.h.

---

Constructor & Destructor Documentation

EchoLink::Qso::Qso (  const Async::IpAddress &  ip, const std::string &  callsign = "", const std::string &  name = "", const std::string &  info = "" )

Constructor. Parameters: ip  The IP-address of the remote station callsign  Callsign of local user (not remote callsign) name  Name of local user (not remote name) info  Local information to send upon connect

EchoLink::Qso::~Qso (  void   )

Destructor.

---

Member Function Documentation

bool EchoLink::Qso::accept (  void   )

Accept an incoming connection. Returns: Returns true if the connect message was sent successfully or false on failure Use this function to accept an incoming connection. Incoming connections are signalled through the EchoLink::Dispatcher. When an incoming connection has been received, a Qso object should be created and this function should be called to accept the connection. Be sure to check that a valid callsign has connected. At least if the EchoLink node is connected to a radio transmitter. The difference between the connect and accept functions are that the accept function goes right into the connected state. The remote station is assumed to be present. This might not be true in some strange cases. In such a strange case, the connection will timeout after a while.

bool EchoLink::Qso::connect (  void   )

Initiate a connection to the remote station. Returns: Returns true if the connect message was sent ok or false on failure Use this function to connect to the remote station. The StateChange signal will be emitted to indicate that a connection is in progress. When the connection has been established, the stateChange signal will be emitted again. On failure to connect, the stateChange signal will be emitted to indicate that the disconnected state has been entered again.

bool EchoLink::Qso::disconnect (  void   )

Initiate a disconnection from the remote station. Returns: Returns true if the disconnection message was sent successfully or false on failure

bool EchoLink::Qso::flushAudioSendBuffer (  void   )

Flush the audio send buffer so that all audio get transmitted. Returns: Returns true on success or false on failure When there is no more audio to send, this function should be called to flush the audio send buffer. If it is not a full audio packet it will be padded with zeros.

bool EchoLink::Qso::initOk (  void   )  [inline]

Check that the initialization went ok. Returns: Returns true if the initialization was ok or false on failure This function should be called after creating a new Qso object to make sure everything went well. Definition at line 190 of file EchoLinkQso.h.

bool EchoLink::Qso::isRemoteInitiated (  void   )  const [inline]

Find out if the connection is remotely initiated or locally initiated. Returns: Return true if the connection is remotely initiated or else false. Note: Valid when either connect or accept has been called Definition at line 355 of file EchoLinkQso.h.

const std::string& EchoLink::Qso::localCallsign (  void   )  const [inline]

Retrieve the local callsign. Returns: Returns the local callsign Definition at line 203 of file EchoLinkQso.h.

const std::string& EchoLink::Qso::localInfo (  void   )  const [inline]

Retrieve the local station info. Returns: Returns the local station info Definition at line 229 of file EchoLinkQso.h.

const std::string& EchoLink::Qso::localName (  void   )  const [inline]

Retrieve the local name. Returns: Returns the local name Definition at line 216 of file EchoLinkQso.h.

bool EchoLink::Qso::receivingAudio (  void   )  const [inline]

Find out if there is audio coming in on this connection. Returns: Return true if audio is being received or else false. Definition at line 362 of file EchoLinkQso.h.

const std::string& EchoLink::Qso::remoteCallsign (  void   )  const [inline]

Get the remote callsign. Returns: Return the callsign of the remote station Note: Valid when the connection has been established Definition at line 346 of file EchoLinkQso.h.

const Async::IpAddress& EchoLink::Qso::remoteIp (  void   )  const [inline]

Get the IP address of the remote station. Returns: Returns the IP address Definition at line 289 of file EchoLinkQso.h.

const std::string& EchoLink::Qso::remoteName (  void   )  const [inline]

Get the remote name. Returns: Return the name of the remote station Note: Valid when the connection has been established Definition at line 333 of file EchoLinkQso.h.

int EchoLink::Qso::sendAudio (  short *  buf, int  len )

Send audio to the remote station. Parameters: buf  A buffer containing 16 bit samples to send len  The length, in samples, of the buffer to send Returns: Returns the number of samples written

bool EchoLink::Qso::sendAudioRaw (  GsmVoicePacket *  packet  )

Send a raw GSM audio packet to the remote station. Parameters: packet  The packet to send This function can be used to send a raw GSM packet to the remote station. Probably only useful if you received it from the audioReceivedRaw signal.

bool EchoLink::Qso::sendChatData (  const std::string &  msg  )

Send chat data to the remote station. Parameters: msg  The message to send Returns: Returns true on success or false on failure

bool EchoLink::Qso::sendInfoData (  const std::string &  info = ""  )

Send info data to the remote station. Parameters: info  The info to send Returns: Returns true on success or false on failure

bool EchoLink::Qso::setLocalCallsign (  const std::string &  callsign  )

Set the local callsign. Parameters: callsign  The callsign to set Returns: Returns true on success or false on failure

void EchoLink::Qso::setLocalInfo (  const std::string &  info  )

Set the local info. Parameters: info  The informational message that is sent to the remote station upon connection.

bool EchoLink::Qso::setLocalName (  const std::string &  name  )

Set the local name (name of station operator). Parameters: name  The name to set Returns: Returns true on success or false on failure

void EchoLink::Qso::setRemoteCallsign (  const std::string &  call  )  [inline]

Set the callsign of the remote station. Parameters: call  The callsign to set Definition at line 339 of file EchoLinkQso.h.

void EchoLink::Qso::setRemoteName (  const std::string &  name  )  [inline]

Set the name of the remote station. Parameters: name  The name to set Definition at line 326 of file EchoLinkQso.h.

---

Member Data Documentation

SigC::Signal2<int, short*, int> EchoLink::Qso::audioReceived

A signal that is emitted when an audio datagram has been received. Parameters: buf  A pointer to the buffer that contains the audio len  The number of samples in the buffer Definition at line 395 of file EchoLinkQso.h.

SigC::Signal1<void, GsmVoicePacket*> EchoLink::Qso::audioReceivedRaw

A signal that is emitted when an audio datagram has been received. Parameters: data  A pointer to the buffer that contains the raw audio packet This signal is emitted whenever an audio packet has been received on the connection. It gives access to the raw GSM packet. This can be used if the encoded data is going to be retransmitted. In this case it is not good to decode and then encode the data again. It will sound awful. Definition at line 406 of file EchoLinkQso.h.

SigC::Signal1<void, const std::string&> EchoLink::Qso::chatMsgReceived

A signal that is emitted when a chat message is received. Parameters: msg  The received chat message Definition at line 374 of file EchoLinkQso.h.

SigC::Signal1<void, const std::string&> EchoLink::Qso::infoMsgReceived

A signal that is emitted when a station info message is received. Parameters: msg  The received message Definition at line 368 of file EchoLinkQso.h.

SigC::Signal1<void, bool> EchoLink::Qso::isReceiving

A signal that is emitted when the audio receive state changes. Parameters: is_receiving  Is true when audio is being received and false when not Note: This signal can be used to control a reception indicator Definition at line 388 of file EchoLinkQso.h.

SigC::Signal1<void, State> EchoLink::Qso::stateChange

A signal that is emitted when the connection state changes. Parameters: state  The new connection state Definition at line 380 of file EchoLinkQso.h.

---

The documentation for this class was generated from the following file:

• EchoLinkQso.h

---