Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

FaxSend Class Reference

Call Module for sending an analog fax (group 3). More...

#include <faxsend.h>

Inheritance diagram for FaxSend:

CallModule CallInterface List of all members.

Public Member Functions

 FaxSend (Connection *conn, string file) throw (CapiExternalError)
 Constructor. Test if we are in fax mode and create an object.
void mainLoop () throw (CapiError,CapiWrongState,CapiExternalError, CapiMsgError)
 Start file send, wait for disconnect and stop the send afterwards.
void transmissionComplete ()
 finish main loop if file is completely sent

Private Attributes

string file
 file name to send

Detailed Description

Call Module for sending an analog fax (group 3).

This module handles the send of an analog fax (fax group 3). It starts the send and waits for the end of the connection.

Fax polling isn't supported yet.

Fax mode must have been established before using this (by connecting in fax mode or switching to fax with Switch2FaxG3), otherwise an exception is caused.

The given file must be in the format used by Capi, i.e. Structured Fax File (SFF).

Author:
Gernot Hillier


Constructor & Destructor Documentation

FaxSend::FaxSend Connection conn,
string  file
throw (CapiExternalError)
 

Constructor. Test if we are in fax mode and create an object.

Parameters:
conn reference to Connection object
file name of file to send
Exceptions:
CapiExternalError Thrown if we are not in fax mode.


Member Function Documentation

void FaxSend::mainLoop  )  throw (CapiError,CapiWrongState,CapiExternalError, CapiMsgError) [virtual]
 

Start file send, wait for disconnect and stop the send afterwards.

Exceptions:
CapiWrongState Thrown when disconnection takes place.
CapiExternalError Thrown by Connection::start_file_transmission. See there for explanation.
CapiMsgError Thrown by Connection::start_file_transmission. See there for explanation.
CapiError Thrown by Connection::start_file_transmission. See there for explanation.

Reimplemented from CallModule.

void FaxSend::transmissionComplete  )  [virtual]
 

finish main loop if file is completely sent

Reimplemented from CallModule.


Member Data Documentation

string FaxSend::file [private]
 

file name to send


The documentation for this class was generated from the following files:
Generated on Sun Nov 28 14:37:45 2004 for CapiSuite by doxygen 1.3.8