Photon Plugins API Documentation
Public Attributes | List of all members
Photon.Hive.Plugin.HttpRequestQueueResult Class Reference

Codes returned as a result of process of queued HTTP request. More...

Public Attributes

const byte Success = 0
 The HTTP request was succesfully processed. More...
 
const byte RequestTimeout = 1
 The HTTP request timed out. More...
 
const byte QueueTimeout = 2
 The HTTP request queue timed out. More...
 
const byte Offline = 3
 If the application's respective HTTP queries' queue is in offline mode. More...
 
const byte QueueFull = 4
 The HTTP request queue is full. More...
 
const byte Error = 5
 An error has occurred while processing the HTTP request. More...
 

Detailed Description

Codes returned as a result of process of queued HTTP request.

Member Data Documentation

const byte Photon.Hive.Plugin.HttpRequestQueueResult.Error = 5

An error has occurred while processing the HTTP request.

If the request's URL couldn't be parsed or the hostname couldn't be resolved or the web service is unreachable. Also this may happen if the endpoint returns an error HTTP status code. e.g. 400 (BAD REQUEST)

const byte Photon.Hive.Plugin.HttpRequestQueueResult.Offline = 3

If the application's respective HTTP queries' queue is in offline mode.

If this return code is received, no HttpRequest should be sent during 10 seconds which is the time the HTTP queue takes to reconnect.

const byte Photon.Hive.Plugin.HttpRequestQueueResult.QueueFull = 4

The HTTP request queue is full.

This happens if the queue of HTTP queries has reached a certain threshold for the respective application.

const byte Photon.Hive.Plugin.HttpRequestQueueResult.QueueTimeout = 2

The HTTP request queue timed out.

A timer starts when a request is put into the HttpRequestQueue. A request can timeout if takes too much time inside the queue.

const byte Photon.Hive.Plugin.HttpRequestQueueResult.RequestTimeout = 1

The HTTP request timed out.

This happens if the endpoint does not return a response in a timely manner.

const byte Photon.Hive.Plugin.HttpRequestQueueResult.Success = 0

The HTTP request was succesfully processed.

If the endpoint returns a successful HTTP status code. i.e. 2xx codes.