Forums
This is the online documentation for Colossus Entertainments Pixie Game Engine

HTTP Class Reference

Inheritance diagram for HTTP:

System

List of all members.


Detailed Description

Functionality to request HTTP resources.

Author:
Mattias Gustavsson
The HTTP system provides high-level functionality for executing HTTP GET and HTTP POST requests, and to receive the response from the server.

All network requests are done asynchronously, so when you issue a request, you're given a handle, and using this handle,

Definition at line 28 of file HTTP.h.


Public Types

enum  RequestStatus {
  Status_Connecting, Status_Pending, Status_Completed, Status_Failed,
  Status_TimedOut, Status_Invalid
}

Public Member Functions

 SYSTEM_IMPLEMENTATION (HTTP)
void Start ()
void Stop ()
void Update (float deltaTime)
int Request_Get (const char *url, float timeOut=0.0f)
int Request_Post (const char *url, const void *data, int size, float timeOut=0.0f)
RequestStatus GetRequestStatus (int requestHandle)
float GetPercentageReceived (int requestHandle)
HTTP_ResourceGetResource (int requestHandle)
void DiscardRequest (int requestHandle)

Classes

struct  Request

Member Enumeration Documentation

Enumerator:
Status_Connecting 
Status_Pending 
Status_Completed 
Status_Failed 
Status_TimedOut 
Status_Invalid 

Definition at line 41 of file HTTP.h.


Member Function Documentation

HTTP::SYSTEM_IMPLEMENTATION ( HTTP   ) 

void HTTP::Start (  )  [virtual]

Reimplemented from System.

Definition at line 12 of file HTTP.cpp.

void HTTP::Stop (  )  [virtual]

Reimplemented from System.

Definition at line 20 of file HTTP.cpp.

void HTTP::Update ( float  deltaTime  ) 

Definition at line 31 of file HTTP.cpp.

int HTTP::Request_Get ( const char *  url,
float  timeOut = 0.0f 
)

Definition at line 215 of file HTTP.cpp.

int HTTP::Request_Post ( const char *  url,
const void *  data,
int  size,
float  timeOut = 0.0f 
)

Definition at line 266 of file HTTP.cpp.

HTTP::RequestStatus HTTP::GetRequestStatus ( int  requestHandle  ) 

Definition at line 318 of file HTTP.cpp.

float HTTP::GetPercentageReceived ( int  requestHandle  ) 

Definition at line 333 of file HTTP.cpp.

HTTP_Resource * HTTP::GetResource ( int  requestHandle  ) 

Definition at line 348 of file HTTP.cpp.

void HTTP::DiscardRequest ( int  requestHandle  ) 

Definition at line 357 of file HTTP.cpp.