Main Page   Class Hierarchy   Compound List   File List   Compound Members  

SmartSockets::TipcMsgFile Class Reference

#include <tmsgfile.h>

List of all members.

Public Methods

 TipcMsgFile (char *filename, T_IPC_MSG_FILE_CREATE_MODE create_mode)
 TipcMsgFile (FILE *file, T_IPC_MSG_FILE_CREATE_MODE create_mode)
virtual ~TipcMsgFile () throw ()
 Destructor.

virtual TipcMsgFile & operator<< (const TipcMsg &msg) throw (TipcException)
virtual TipcMsgFile & operator>> (TipcMsg &msg)


Detailed Description

TipcMsgFile - user class for message file I/O operations The TipcMsgFile class provides a C++ binding to the SmartSockets TipcMsgFile API functions using a virtual I/O stream model. It allows you to create, read, write, append to and close SmartSockets message files using C++ stream I/O syntax.


Constructor & Destructor Documentation

SmartSockets::TipcMsgFile::TipcMsgFile char *    filename,
T_IPC_MSG_FILE_CREATE_MODE    create_mode
 

Create a TipcMsgFile object with file_name and create_mode.

Parameters:
file_name  - the name of the file to use for the message file.
create_mode  - specifies how to create the file.

SmartSockets::TipcMsgFile::TipcMsgFile FILE *    file,
T_IPC_MSG_FILE_CREATE_MODE    create_mode
 

Create a TipcMsgFile object with file and create_mode.

Parameters:
file  - an existing file to use for the message file.
create_mode  - specifies how to create (that is,open) the file.


Member Function Documentation

virtual TipcMsgFile& SmartSockets::TipcMsgFile::operator<< const TipcMsg   msg throw (TipcException) [virtual]
 

Write the internal T_IPC_MSG field of a TipcMsg object to a message file.

virtual TipcMsgFile& SmartSockets::TipcMsgFile::operator>> TipcMsg   msg [virtual]
 

Read a message from a message file and assign it to the internal T_IPC_MSG field of a TipcMsg object. Any message that the object was managing at the time of the call is passed to TipcMsgDestroy().


The documentation for this class was generated from the following file:
Generated on Fri Jul 14 15:05:56 2006 by doxygen1.2.12 written by Dimitri van Heesch, © 1997-2001