1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
|
/* -*- c++ -*- */
//=============================================================================
/**
* @file Jaws_IO.h
*
* $Id: Jaws_IO.h 93652 2011-03-28 08:55:39Z johnnyw $
*
* @author James Hu
*/
//=============================================================================
#ifndef JAWS_IO_H
#define JAWS_IO_H
#include "ace/ACE.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
#include "ace/Asynch_IO.h"
#include "ace/SOCK_Stream.h"
#include "ace/Singleton.h"
#include "ace/Synch_Traits.h"
#include "JAWS/Export.h"
ACE_BEGIN_VERSIONED_NAMESPACE_DECL
class ACE_Message_Block;
ACE_END_VERSIONED_NAMESPACE_DECL
class JAWS_IO_Handler;
class JAWS_IO_Acceptor;
/**
* @class JAWS_IO
*
* @brief This class defines the abstract interface for an I/O class in
* the context of Web-likes servers
*
* An I/O class should have the following interface. Derived
* classes will define the exactly how the I/O will take place
* (Asynchronous, Synchronous, Reactive)
*/
class JAWS_Export JAWS_IO
{
public:
JAWS_IO (void);
virtual ~JAWS_IO (void);
// void acceptor (JAWS_IO_Acceptor *acceptor);
// void handler (JAWS_IO_Handler *handler);
// void handle (ACE_HANDLE h);
// ACE_HANDLE handle (void);
// James, please add documentation here.
/// accept a passive connection
virtual void accept (JAWS_IO_Handler *ioh,
ACE_Message_Block *mb = 0,
unsigned int size = 0) = 0;
/// read from the handle size bytes into the message block.
virtual void read (JAWS_IO_Handler *ioh,
ACE_Message_Block *mb,
unsigned int size) = 0;
/// send header, filename, trailer to the handle.
virtual void transmit_file (JAWS_IO_Handler *ioh,
ACE_HANDLE file,
const char *header,
unsigned int header_size,
const char *trailer,
unsigned int trailer_size) = 0;
/// send header, filename, trailer to the handle.
virtual void transmit_file (JAWS_IO_Handler *ioh,
const char *filename,
const char *header,
unsigned int header_size,
const char *trailer,
unsigned int trailer_size) = 0;
/// read data from the handle and store in filename.
virtual void receive_file (JAWS_IO_Handler *ioh,
const char *filename,
void *initial_data,
unsigned int initial_data_length,
unsigned int entire_length) = 0;
/// send a confirmation message to the handle.
virtual void send_confirmation_message (JAWS_IO_Handler *ioh,
const char *buffer,
unsigned int length) = 0;
/// send an error message to the handle.
virtual void send_error_message (JAWS_IO_Handler *ioh,
const char *buffer,
unsigned int length) = 0;
protected:
ACE_HANDLE handle_;
JAWS_IO_Handler *handler_;
ACE_INET_Addr *inet_addr_;
JAWS_IO_Acceptor *acceptor_;
};
/**
* @class JAWS_Synch_IO
*
* @brief This class defines the interface for a Synchronous I/O class.
*
*/
class JAWS_Export JAWS_Synch_IO : public JAWS_IO
{
public:
JAWS_Synch_IO (void);
virtual ~JAWS_Synch_IO (void);
virtual void accept (JAWS_IO_Handler *ioh,
ACE_Message_Block *mb = 0,
unsigned int size = 0);
virtual void read (JAWS_IO_Handler *ioh,
ACE_Message_Block *mb,
unsigned int size);
virtual void transmit_file (JAWS_IO_Handler *ioh,
ACE_HANDLE handle,
const char *header,
unsigned int header_size,
const char *trailer,
unsigned int trailer_size);
virtual void transmit_file (JAWS_IO_Handler *ioh,
const char *filename,
const char *header,
unsigned int header_size,
const char *trailer,
unsigned int trailer_size);
virtual void receive_file (JAWS_IO_Handler *ioh,
const char *filename,
void *initial_data,
unsigned int initial_data_length,
unsigned int entire_length);
virtual void send_confirmation_message (JAWS_IO_Handler *ioh,
const char *buffer,
unsigned int length);
virtual void send_error_message (JAWS_IO_Handler *ioh,
const char *buffer,
unsigned int length);
protected:
virtual void send_message (JAWS_IO_Handler *ioh,
const char *buffer,
unsigned int length);
};
typedef ACE_Singleton<JAWS_Synch_IO, ACE_SYNCH_MUTEX>
JAWS_Synch_IO_Singleton;
// This only works on asynch I/O-capable systems.
#if defined (ACE_HAS_WIN32_OVERLAPPED_IO) || defined (ACE_HAS_AIO_CALLS)
/**
* @class JAWS_Asynch_IO
*
* @brief This class defines the interface for a Asynchronous I/O class.
*
*/
class JAWS_Export JAWS_Asynch_IO : public JAWS_IO
{
public:
JAWS_Asynch_IO (void);
virtual ~JAWS_Asynch_IO (void);
virtual void accept (JAWS_IO_Handler *ioh,
ACE_Message_Block *mb = 0,
unsigned int size = 0);
virtual void read (JAWS_IO_Handler *ioh,
ACE_Message_Block *mb,
unsigned int size);
virtual void transmit_file (JAWS_IO_Handler *ioh,
ACE_HANDLE handle,
const char *header,
unsigned int header_size,
const char *trailer,
unsigned int trailer_size);
virtual void transmit_file (JAWS_IO_Handler *ioh,
const char *filename,
const char *header,
unsigned int header_size,
const char *trailer,
unsigned int trailer_size);
virtual void receive_file (JAWS_IO_Handler *ioh,
const char *filename,
void *initial_data,
unsigned int initial_data_length,
unsigned int entire_length);
virtual void send_confirmation_message (JAWS_IO_Handler *ioh,
const char *buffer,
unsigned int length);
virtual void send_error_message (JAWS_IO_Handler *ioh,
const char *buffer,
unsigned int length);
#ifdef ACE_LYNXOS_MAJOR
#ifdef ERROR_MESSAGE
#undef ERROR_MESSAGE
#endif /* ERROR_MESSAGE */
#endif /* ACE_LYNXOS_MAJOR */
enum Message_Types
{
CONFIRMATION,
ERROR_MESSAGE
};
protected:
virtual void send_message (JAWS_IO_Handler *ioh,
const char *buffer,
unsigned int length,
long act);
};
typedef ACE_Singleton<JAWS_Asynch_IO, ACE_SYNCH_MUTEX>
JAWS_Asynch_IO_Singleton;
/**
* @class JAWS_Asynch2_IO
This version of Asynch_IO has a do nothing accept() implementation.
*/
class JAWS_Export JAWS_Asynch2_IO : public JAWS_Asynch_IO
{
public:
/// does nothing
virtual void accept (JAWS_IO_Handler *ioh,
ACE_Message_Block *mb = 0,
unsigned int size = 0);
};
typedef ACE_Singleton<JAWS_Asynch2_IO, ACE_SYNCH_MUTEX>
JAWS_Asynch2_IO_Singleton;
#endif /* ACE_HAS_WIN32_OVERLAPPED_IO || ACE_HAS_AIO_CALLS */
#endif /* JAWS_IO_H */
|