ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

Networking Namespace Reference

Namespaces

namespace  Connection

Classes

class  ConnectionManager
class  CurlJsonRequest
class  CurlRequest
class  NetworkReadStream
struct  Response
 Response<T> is a struct to be returned from Request to user's callbacks. More...
struct  ErrorResponse
 ErrorResponse is a struct to be returned from Request to user's failure callbacks. More...
class  Request
class  ClientHandler
class  Client
 Client class represents one client's HTTP request to the LocalWebserver. More...
class  GetClientHandler
class  BaseHandler
class  CreateDirectoryHandler
class  DownloadFileHandler
class  FilesAjaxPageHandler
class  FilesBaseHandler
class  FilesPageHandler
class  IndexPageHandler
class  ListAjaxHandler
class  ResourceHandler
class  UploadFileHandler
class  HandlerUtils
class  LocalWebserver
class  Reader
 This is a helper class for Client. More...
class  UploadFileClientHandler
 This class handles POST form/multipart upload. More...

Typedefs

typedef Response
< Common::JSONValue * > 
JsonResponse
typedef Common::BaseCallback
< JsonResponse > * 
JsonCallback
typedef Response
< NetworkReadStream * > 
NetworkReadStreamResponse
typedef Common::BaseCallback
< NetworkReadStreamResponse > * 
NetworkReadStreamCallback
typedef Response< void * > DataReponse
typedef Common::BaseCallback
< DataReponse > * 
DataCallback
typedef Common::BaseCallback
< ErrorResponse > * 
ErrorCallback

Enumerations

enum  RequestState { PROCESSING, PAUSED, RETRY, FINISHED }
 

RequestState is used to indicate current Request state.

More...
enum  ClientState {
  INVALID, READING_HEADERS, READ_HEADERS, BAD_REQUEST,
  BEING_HANDLED
}
enum  ReaderState { RS_NONE, RS_READING_HEADERS, RS_READING_CONTENT }
enum  UploadFileHandlerState {
  UFH_READING_CONTENT, UFH_READING_BLOCK_HEADERS, UFH_READING_BLOCK_CONTENT, UFH_ERROR,
  UFH_STOP
}

Functions

void connectionsThread (void *ignored)
static int curlProgressCallback (void *p, curl_off_t dltotal, curl_off_t dlnow, curl_off_t ultotal, curl_off_t ulnow)
void localWebserverTimer (void *ignored)

Typedef Documentation

Definition at line 86 of file request.h.

Definition at line 85 of file request.h.


Enumeration Type Documentation

Enumerator:
INVALID 
READING_HEADERS 
READ_HEADERS 
BAD_REQUEST 
BEING_HANDLED 

Definition at line 38 of file client.h.

Enumerator:
RS_NONE 
RS_READING_HEADERS 
RS_READING_CONTENT 

Definition at line 37 of file reader.h.

RequestState is used to indicate current Request state.

ConnectionManager uses it to decide what to do with the Request.

PROCESSING state indicates that Request is working. ConnectionManager calls handle() method of Requests in that state.

PAUSED state indicates that Request is not working. ConnectionManager keeps Requests in that state and doesn't call any methods of those.

RETRY state indicates that Request must restart after a few seconds. ConnectionManager calls handleRetry() method of Requests in that state. Default handleRetry() implementation decreases _retryInSeconds value until it reaches zero. When it does, Request's restart() method is called.

FINISHED state indicates that Request did the work and might be deleted. ConnectionManager deletes Requests in that state. After this state is set, but before ConnectionManager deletes the Request, Request calls user's callback. User can ask Request to change its state by calling retry() or pause() methods and Request won't be deleted.

Request get a success and failure callbacks. Request must call one (and only one!) of these callbacks when it sets FINISHED state.

Enumerator:
PROCESSING 
PAUSED 
RETRY 
FINISHED 

Definition at line 113 of file request.h.

Enumerator:
UFH_READING_CONTENT 
UFH_READING_BLOCK_HEADERS 
UFH_READING_BLOCK_CONTENT 
UFH_ERROR 
UFH_STOP 

Definition at line 31 of file uploadfileclienthandler.h.


Function Documentation

void Networking::connectionsThread ( void *  ignored  ) 

Definition at line 103 of file connectionmanager.cpp.

static int Networking::curlProgressCallback ( void *  p,
curl_off_t  dltotal,
curl_off_t  dlnow,
curl_off_t  ultotal,
curl_off_t  ulnow 
) [static]

Definition at line 53 of file networkreadstream.cpp.

void Networking::localWebserverTimer ( void *  ignored  ) 

Definition at line 81 of file localwebserver.cpp.



Generated on Sat Feb 16 2019 05:05:45 for ResidualVM by doxygen 1.7.1
curved edge   curved edge