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

FaxReceive Class Reference

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

#include <faxreceive.h>

Inheritance diagram for FaxReceive:

CallModule CallInterface List of all members.

Public Member Functions

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

Private Attributes

string file
 file name to save file to

Detailed Description

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

This module handles the reception of an analog fax (fax group 3). It starts the reception 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 created file will be saved in the format received by Capi, i.e. as Structured Fax File (SFF).

Author:
Gernot Hillier


Constructor & Destructor Documentation

FaxReceive::FaxReceive 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 save recorded stream to
Exceptions:
CapiExternalError Thrown if we are not in fax mode.


Member Function Documentation

void FaxReceive::mainLoop  )  throw (CapiWrongState, CapiExternalError) [virtual]
 

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

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

Reimplemented from CallModule.

void FaxReceive::transmissionComplete  )  [virtual]
 

finish main loop if file is completely received

Reimplemented from CallModule.


Member Data Documentation

string FaxReceive::file [private]
 

file name to save file to


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