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 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
|
/* -*- c++ -*- */
//=============================================================================
/**
* @file IO_Handler.h
*
* $Id: IO_Handler.h 93652 2011-03-28 08:55:39Z johnnyw $
*
* @author James Hu
*/
//=============================================================================
#ifndef JAWS_IO_HANDLER_H
#define JAWS_IO_HANDLER_H
#include "ace/Asynch_IO.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
#include "ace/Singleton.h"
#include "ace/Synch_Traits.h"
#include "ace/RW_Thread_Mutex.h"
#include "JAWS/Export.h"
class JAWS_IO;
class JAWS_Synch_IO;
class JAWS_Asynch_IO;
class JAWS_IO_Handler;
class JAWS_IO_Handler_Factory;
class JAWS_Data_Block;
class JAWS_Pipeline_Handler;
class JAWS_Waiter;
ACE_BEGIN_VERSIONED_NAMESPACE_DECL
class ACE_Message_Block;
ACE_END_VERSIONED_NAMESPACE_DECL
/**
* @class JAWS_Abstract_IO_Handler
*
* @brief This class defines the abstract interface for an I/O handler
* class in the context of Web-likes servers
*
*/
class JAWS_Export JAWS_Abstract_IO_Handler
{
public:
virtual ~JAWS_Abstract_IO_Handler (void);
virtual void task (JAWS_Pipeline_Handler *ph) = 0;
virtual JAWS_Pipeline_Handler *task (void) = 0;
virtual void message_block (JAWS_Data_Block *mb) = 0;
virtual JAWS_Data_Block *message_block (void) = 0;
/// This method is called by the IO class when new passive connection has
/// been established.
virtual void accept_complete (ACE_HANDLE handle) = 0;
/// This method is called by the IO class when new passive connection has
/// been established.
virtual void accept_error (void) = 0;
#if 0
/// This method is called by the IO class when new active connection has
/// been established.
virtual void connect_complete (ACE_Message_Block *) = 0;
/// This method is called by the IO class when new active connection has
/// been established.
virtual void connect_error (ACE_Message_Block *) = 0;
#endif
/// This method is called by the IO class when new client data shows
/// up.
virtual void read_complete (ACE_Message_Block *data) = 0;
/// This method is called by the IO class when there was an error in
/// reading new data from the client.
virtual void read_error (void) = 0;
/// This method is called by the IO class when the requested file has
/// been successfully transmitted to the client.
virtual void transmit_file_complete (void) = 0;
/// This method is called by the IO class when there was an error in
/// transmitting the requested file to the client.
virtual void transmit_file_error (int result) = 0;
/// This method is called by the IO class when the requested file has
/// been successfully received from the client.
virtual void receive_file_complete (void) = 0;
/// This method is called by the IO class when there was an error in
/// receiving the requested file from the client.
virtual void receive_file_error (int result) = 0;
/// This method is called by the IO class when there was an error in
/// writing data to the client.
virtual void write_error (void) = 0;
/// This method is called by the IO class when the confirmation
/// message has been delivered to the client.
virtual void confirmation_message_complete (void) = 0;
/// This method is called by the IO class when the error message has
/// been delivered to the client.
virtual void error_message_complete (void) = 0;
/// Returns the factory for this IO handler
virtual JAWS_IO_Handler_Factory *factory (void) = 0;
/// Returns the socket handle for this handler
virtual ACE_HANDLE handle (void) const = 0;
/// Cleans up the handler.
virtual void done (void) = 0;
/// Returns the status of the handler
virtual int status (void) = 0;
/// puts handler in an idle state
virtual void idle (void) = 0;
enum { IDLE = 0, IDLE_A = 1,
ACCEPT_OK = 2, ACCEPT_OK_A = 3,
ACCEPT_ERROR = 4, ACCEPT_ERROR_A = 5,
READ_OK = 6, READ_OK_A = 7,
READ_ERROR = 8, READ_ERROR_A = 9,
WRITE_OK = 10, WRITE_OK_A = 11,
WRITE_ERROR = 12, WRITE_ERROR_A = 13,
TRANSMIT_OK = 14, TRANSMIT_OK_A = 15,
TRANSMIT_ERROR = 16, TRANSMIT_ERROR_A = 17,
RECEIVE_OK = 18, RECEIVE_OK_A = 19,
/// The different states of the handler
RECEIVE_ERROR = 20, RECEIVE_ERROR_A = 21 };
};
#if defined (ACE_HAS_WIN32_OVERLAPPED_IO) || defined(ACE_HAS_AIO_CALLS)
// Forward reference.
class JAWS_Asynch_IO_Handler;
class JAWS_Export JAWS_Asynch_Handler : public ACE_Service_Handler
{
public:
JAWS_Asynch_Handler (void);
virtual ~JAWS_Asynch_Handler (void);
/// This method will be called when an asynchronous read completes on
/// a stream.
virtual void handle_read_stream (const ACE_Asynch_Read_Stream::Result
&result);
/// This method will be called when an asynchronous write completes
/// on a stream.
virtual void handle_write_stream (const ACE_Asynch_Write_Stream::Result
&result);
/// This method will be called when an asynchronous transmit file
/// completes.
virtual void handle_transmit_file (const ACE_Asynch_Transmit_File::Result
&result);
/// This method will be called when an asynchronous accept completes.
virtual void handle_accept (const ACE_Asynch_Accept::Result &result);
virtual void handler (JAWS_Asynch_IO_Handler *ioh);
virtual JAWS_Asynch_IO_Handler * handler (void);
virtual void dispatch_handler (void);
/// Call back entry point for ACE_Asynch_Acceptor
virtual void open (ACE_HANDLE h, ACE_Message_Block &mb);
/// Receives the ACT.
virtual void act (const void *act_ref);
//virtual ACE_HANDLE handle (void) const;
private:
JAWS_Asynch_IO_Handler *ioh_;
};
#endif /* defined(ACE_HAS_WIN32_OVERLAPPED_IO) || defined(ACE_HAS_AIO_CALLS) */
class JAWS_Export JAWS_IO_Handler : public JAWS_Abstract_IO_Handler
{
public:
JAWS_IO_Handler (JAWS_IO_Handler_Factory *factory);
virtual ~JAWS_IO_Handler (void);
// Inherited from JAWS_IO_Handler
virtual void accept_complete (ACE_HANDLE handle);
virtual void accept_error (void);
virtual void read_complete (ACE_Message_Block *data);
virtual void read_error (void);
virtual void transmit_file_complete (void);
virtual void transmit_file_error (int result);
virtual void receive_file_complete (void);
virtual void receive_file_error (int result);
virtual void write_error (void);
virtual void confirmation_message_complete (void);
virtual void error_message_complete (void);
virtual JAWS_IO_Handler_Factory *factory (void);
virtual ACE_HANDLE handle (void) const;
virtual void done (void);
virtual int status (void);
virtual void idle (void);
virtual void acquire (void);
virtual void lock (void);
virtual void release (void);
virtual void task (JAWS_Pipeline_Handler *ph);
virtual JAWS_Pipeline_Handler *task (void);
virtual void message_block (JAWS_Data_Block *mb);
virtual JAWS_Data_Block *message_block (void);
protected:
/// The state of the handler.
int status_;
/// This maintains the state of the request.
JAWS_Data_Block *mb_;
/// The socket handle returned from accept.
ACE_HANDLE handle_;
/// This is a reference to the next stage of the pipeline when the IO
/// request completes.
JAWS_Pipeline_Handler *task_;
/// The reference to the handler's factory.
JAWS_IO_Handler_Factory *factory_;
};
class JAWS_Export JAWS_IO_Handler_Factory
{
public:
/// Destructor
virtual ~JAWS_IO_Handler_Factory (void);
/// This creates a new JAWS_IO_Handler
virtual JAWS_IO_Handler *create_io_handler (void);
/// This deletes a JAWS_IO_Handler
virtual void destroy_io_handler (JAWS_IO_Handler *handler);
};
typedef JAWS_IO_Handler JAWS_Synch_IO_Handler;
typedef JAWS_IO_Handler_Factory JAWS_Synch_IO_Handler_Factory;
typedef ACE_Singleton<JAWS_Synch_IO_Handler_Factory, ACE_SYNCH_MUTEX>
JAWS_Synch_IO_Handler_Factory_Singleton;
#if defined(ACE_HAS_WIN32_OVERLAPPED_IO) || defined(ACE_HAS_AIO_CALLS)
class JAWS_Export JAWS_Asynch_IO_Handler_Factory : public JAWS_IO_Handler_Factory
{
public:
/// Destructor
virtual ~JAWS_Asynch_IO_Handler_Factory (void);
/// This creates a new JAWS_IO_Handler
virtual JAWS_IO_Handler *create_io_handler (void);
/// This deletes a JAWS_IO_Handler
virtual void destroy_io_handler (JAWS_IO_Handler *handler);
};
class JAWS_Export JAWS_Asynch_IO_Handler : public JAWS_IO_Handler
{
friend class JAWS_Asynch_Handler;
friend class JAWS_Asynch_IO_Handler_Factory;
friend class JAWS_Waiter;
// Provide implementations for the common functions.
public:
explicit JAWS_Asynch_IO_Handler (JAWS_Asynch_IO_Handler_Factory *factory);
virtual ~JAWS_Asynch_IO_Handler (void);
virtual ACE_Handler *handler (void);
virtual void acquire (void);
virtual void lock (void);
virtual void release (void);
protected:
JAWS_Asynch_Handler *handler_;
ACE_SYNCH_RW_MUTEX count_;
};
#else
typedef JAWS_IO_Handler JAWS_Asynch_IO_Handler;
typedef JAWS_IO_Handler_Factory JAWS_Asynch_IO_Handler_Factory;
#endif /* defined(ACE_HAS_WIN32_OVERLAPPED_IO) || defined(ACE_HAS_AIO_CALLS) */
typedef ACE_Singleton<JAWS_Asynch_IO_Handler_Factory, ACE_SYNCH_MUTEX>
JAWS_Asynch_IO_Handler_Factory_Singleton;
#endif /* JAWS_IO_HANDLER_H */
|