Constants
[HTTP Library]


Data Structures

struct  _AlpHttpAuthInfo
struct  _AlpHttpDate
struct  _AlpHttpIPAddr
 IP address structure Used to set DNS server Address. More...
struct  _AlpHttpStrSplit

HTTP Library callback functions

typedef int(* alp_http_class_notifystateproc )(AlpHttpStreamHandle streamH, AlpHttpURLStr in_url, int in_state, AlpHttpOpaque in_aux)
 This is a callback function to get AlpHttpStream state.
typedef int(* alp_http_client_certconfirmproc )(AlpHttpSSL in_ssl, AlpHttpClientCertList in_list, AlpHttpOpaque in_aux)
 This is a callback function to select a client's certlist.
typedef int(* alp_http_cookie_confirmproc )(AlpHttpCookies in_cookies, AlpHttpURLStr in_url, char *in_header, int in_header_len, AlpHttpOpaque in_aux)
 This is a callback function to confirm whether or not to accept a Cookie.
typedef int(* alp_http_server_certconfirmproc )(AlpHttpSSL in_ssl, int in_verify_result, AlpHttpCertList in_list, AlpHttpOpaque in_aux)
 This is a callback function to confirm whether or not to accept server's certificate.

Defines

#define ALP_HTTP_ERROR_DECLARE(sys_class_id, error_id)   ((alp_status_t)((alp_status_t)(sys_class_id) | (alp_status_t)(error_id) << 16))
#define ALP_STATUS_HTTP_CODE_ACCEPTED   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x13)
#define ALP_STATUS_HTTP_CODE_BAD_GATEWAY   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x33)
#define ALP_STATUS_HTTP_CODE_BAD_REQUEST   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x1F)
#define ALP_STATUS_HTTP_CODE_CONFLICT   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x28)
#define ALP_STATUS_HTTP_CODE_CONTINUE   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x0F)
#define ALP_STATUS_HTTP_CODE_CREATED   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x12)
#define ALP_STATUS_HTTP_CODE_EXPECTATION_FAILED   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x30)
#define ALP_STATUS_HTTP_CODE_FORBIDDEN   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x22)
#define ALP_STATUS_HTTP_CODE_FOUND   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x1A)
#define ALP_STATUS_HTTP_CODE_GATEWAY_TIMEOUT   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x35)
#define ALP_STATUS_HTTP_CODE_GONE   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x29)
#define ALP_STATUS_HTTP_CODE_HTTPVERSION_NOT_SUPPORTED   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x36)
#define ALP_STATUS_HTTP_CODE_INTERNAL_SERVER_ERROR   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x31)
#define ALP_STATUS_HTTP_CODE_LENTH_REQUIRED   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x2A)
#define ALP_STATUS_HTTP_CODE_METHOD_NOT_ALLOWED   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x24)
#define ALP_STATUS_HTTP_CODE_MOVE_PERMANENTLY   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x19)
#define ALP_STATUS_HTTP_CODE_MULTIPLE_CHOICES   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x18)
#define ALP_STATUS_HTTP_CODE_NO_CONTENT   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x15)
#define ALP_STATUS_HTTP_CODE_NON_AUTHORITATIVE_INFORMATION   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x14)
#define ALP_STATUS_HTTP_CODE_NOT_ACCEPTABLE   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x25)
#define ALP_STATUS_HTTP_CODE_NOT_FOUND   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x23)
#define ALP_STATUS_HTTP_CODE_NOT_IMPLEMENTED   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x32)
#define ALP_STATUS_HTTP_CODE_NOT_MODIFIED   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x1C)
#define ALP_STATUS_HTTP_CODE_OK   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x11)
#define ALP_STATUS_HTTP_CODE_PARTIAL_CONTENT   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x17)
#define ALP_STATUS_HTTP_CODE_PAYMENT_REQUIRED   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x21)
#define ALP_STATUS_HTTP_CODE_PRECONDITION_FAILED   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x2B)
#define ALP_STATUS_HTTP_CODE_PROXY_AUTHENTICATION_REQUIRED   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x26)
#define ALP_STATUS_HTTP_CODE_REQUEST_ENTITY_TOOLARGE   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x2C)
#define ALP_STATUS_HTTP_CODE_REQUEST_TIMEOUT   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x27)
#define ALP_STATUS_HTTP_CODE_REQUEST_URI_TOOLARGE   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x2D)
#define ALP_STATUS_HTTP_CODE_REQUESTED_RANGE_NOT_SATISFIABLE   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x2F)
#define ALP_STATUS_HTTP_CODE_RESET_CONTENT   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x16)
#define ALP_STATUS_HTTP_CODE_SEE_OTHER   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x1B)
#define ALP_STATUS_HTTP_CODE_SERVICE_UNAVAILABLE   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x34)
#define ALP_STATUS_HTTP_CODE_SWITCHING_PROTOCOLS   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x10)
#define ALP_STATUS_HTTP_CODE_TEMPORARY_REDIRECT   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x1E)
#define ALP_STATUS_HTTP_CODE_UNAUTHORIZED   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x20)
#define ALP_STATUS_HTTP_CODE_UNSUPPORTED_MEDIATYPE   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x2E)
#define ALP_STATUS_HTTP_CODE_USE_PROXY   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x1D)
#define ALP_STATUS_HTTP_ERROR_DNS_ERROR   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x09)
#define ALP_STATUS_HTTP_ERROR_EOF   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x07)
#define ALP_STATUS_HTTP_ERROR_GENERIC   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x01)
#define ALP_STATUS_HTTP_ERROR_INVAL   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x06)
#define ALP_STATUS_HTTP_ERROR_IOSLEEP   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x03)
#define ALP_STATUS_HTTP_ERROR_NO_MEMORY   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x04)
#define ALP_STATUS_HTTP_ERROR_NOT_SUPPORTED   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x08)
#define ALP_STATUS_HTTP_ERROR_OK   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x00)
#define ALP_STATUS_HTTP_ERROR_OTHER_ERROR   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x0E)
#define ALP_STATUS_HTTP_ERROR_REQUEST_TIMEDOUT   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x0C)
#define ALP_STATUS_HTTP_ERROR_RESPONSE_TIMEDOUT   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x0D)
#define ALP_STATUS_HTTP_ERROR_SSL_ERROR   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x0B)
#define ALP_STATUS_HTTP_ERROR_STRPIPE   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x05)
#define ALP_STATUS_HTTP_ERROR_TCP_ERROR   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x0A)
#define ALP_STATUS_HTTP_ERROR_WOULDBLOCK   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x02)
#define HTTP_FALSE   0
#define HTTP_TRUE   (!HTTP_FALSE)
#define httpIPAddrTypeV4   4
#define httpPostMULTIPART   0x00000004
#define httpPostPLAINTEXT   0x00000002
#define httpPostURLENCODED   0x00000001
#define httpSSLFlagConnTLS   0x00000004
#define httpSSLFlagConnV2   0x00000001
#define httpSSLFlagConnV2TLS   (httpSSLFlagConnV2 | httpSSLFlagConnTLS)
#define httpSSLFlagConnV2V3   (httpSSLFlagConnV2 | httpSSLFlagConnV3)
#define httpSSLFlagConnV2V3TLS   (httpSSLFlagConnV2 | httpSSLFlagConnV3 | httpSSLFlagConnTLS)
#define httpSSLFlagConnV3   0x00000002
#define httpSSLFlagConnV3TLS   (httpSSLFlagConnV3 | httpSSLFlagConnTLS)
#define httpStreamRead   0x00000001
#define httpStreamReadWrite   (httpStreamRead|httpStreamWrite)
#define httpStreamTextCRCR   "\015\015"
#define httpStreamTextCRLF   "\015\012"
#define httpStreamTextCRLFCRLF   "\015\012\015\012"
#define httpStreamTextLFLF   "\012\012"
#define httpStreamWrite   0x00000002

Typedefs

typedef _AlpHttpAuthInfo AlpHttpAuthInfo
typedef AlpHttpAuthInfoAlpHttpAuthInfoHandle
typedef enum _AlpHttpAuthTarget AlpHttpAuthTargetEnum
typedef enum _AlpHttpAuthType AlpHttpAuthTypeEnum
typedef void * AlpHttpCertList
typedef void * AlpHttpCertPtr
typedef void * AlpHttpClassHandle
typedef void * AlpHttpClientCertList
typedef enum _AlpHttpCookie AlpHttpCookieEnum
typedef void * AlpHttpCookies
typedef void * AlpHttpDataHandle
typedef _AlpHttpDate AlpHttpDate
typedef enum _AlpHttpError AlpHttpErrorEnum
typedef void * AlpHttpFixedStr
typedef enum _AlpHttpHeaderID AlpHttpHeaderIDEnum
typedef _AlpHttpIPAddr AlpHttpIPAddr
typedef enum _AlpHttpMethod AlpHttpMethodEnum
typedef void * AlpHttpOpaque
typedef enum _AlpHttpScheme AlpHttpSchemeEnum
typedef void * AlpHttpSSL
typedef void * AlpHttpSSLClassHandle
typedef enum _AlpHttpStatusCode AlpHttpStatusCodeEnum
typedef void * AlpHttpStreamHandle
typedef enum _AlpHttpStreamState AlpHttpStreamStateEnum
typedef void * AlpHttpString
typedef _AlpHttpStrSplit AlpHttpStrSplit
typedef void * AlpHttpURLStr
typedef enum _AlpHttpVersion AlpHttpVersionEnum
typedef void * AlpHttpVHandle

Enumerations

enum  { httpDNSModeIPV4Only = 0 }
 Const for DNS mode. More...
enum  {
  httpCertDNCountryName = 0, httpCertDNStateOrProvinceName, httpCertDNLocalityName, httpCertDNStreetAddress,
  httpCertDNOrganizationName, httpCertDNOrganizationUnitName, httpCertDNCommonName, httpCertDNEmailAddress,
  httpCertDNAttributs
}
 Constants for Certificate's Attribute. More...
enum  {
  httpCertListTypeUnknown = 0, httpCertListTypeServer, httpCertListTypeClient, httpCertListTypeBrowser,
  httpCertListTypeTypes
}
 Constants for CertList Type. More...
enum  {
  httpCertListEOK = 0, httpCertListEGeneric = -1, httpCertListENoMem = -2, httpCertListESame = -3,
  httpCertListEDecode = -4, httpCertListEFull = -5
}
 Constans for CertList error type. More...
enum  _AlpHttpAuthTarget { httpAuthTargetPage = 0, httpAuthTargetProxy, httpAuthTargetTargets }
 Const for HTTP Access Authentication target. More...
enum  _AlpHttpAuthType { httpAuthTypeNone = -1, httpAuthTypeBasic = 0, httpAuthTypeDigest, httpAuthTypeTypes }
 Const for HTTP Authentication type. More...
enum  _AlpHttpCookie { httpCookieNotifyBeforeSet = 0, httpCookieAlwaysSet, httpCookieNeverSet }
 Constant for cookie mode. More...
enum  _AlpHttpError {
  httpErrorOK = 0, httpErrorGeneric = -1, httpErrorWouldBlock = -2, httpErrorIOSleep = -3,
  httpErrorNoMem = -6, httpErrorStrPipe = -7, httpErrorInval = -8, httpErrorEOF = -9,
  httpErrorNotSupported = -10, httpErrorDNSInval = -200, httpErrorDNSNoServer, httpErrorDNSTimedout,
  httpErrorDNSNotFound, httpErrorTCPOpen, httpErrorTCPConnect, httpErrorTCPRead,
  httpErrorTCPWrite, httpErrorSSLConnect, httpErrorSSLHandShake, httpErrorSSLRead,
  httpErrorSSLWrite, httpErrorReqTimedout, httpErrorRspTimedout, httpErrorCacheNone,
  httpErrorCacheExpire, httpErrorAuthUnknown, httpErrorAuthNoHeader, httpErrorAuthFormat,
  httpErrorAuthIgnored, httpErrorRedirectFormat, httpErrorRedirectCanceled, httpErrorRedirectIgnored,
  httpErrorReqHeaderSizeOver, httpErrorReqBodySizeOver, httpErrorRspHeaderSizeOver, httpErrorReqTooManyContinue,
  httpErrorTLSIntolerant
}
 Constant for HTTP Library APIs error return code. More...
enum  _AlpHttpHeaderID {
  httpHeaderIDCacheControl, httpHeaderIDConnection, httpHeaderIDDate, httpHeaderIDPragma,
  httpHeaderIDTrailer, httpHeaderIDTransferEncoding, httpHeaderIDUpgrade, httpHeaderIDVia,
  httpHeaderIDWarning, httpHeaderIDKeepAlive, httpHeaderIDProxyConnection, httpHeaderIDAccept,
  httpHeaderIDAcceptCharset, httpHeaderIDAcceptEncoding, httpHeaderIDAcceptLanguage, httpHeaderIDAuthorization,
  httpHeaderIDExpect, httpHeaderIDFrom, httpHeaderIDHost, httpHeaderIDIfMatch,
  httpHeaderIDIfModifiedSince, httpHeaderIDIfNoneMatch, httpHeaderIDIfRange, httpHeaderIDIfUnmodifiedSince,
  httpHeaderIDMaxForwards, httpHeaderIDProxyAuthorization, httpHeaderIDRange, httpHeaderIDReferer,
  httpHeaderIDTE, httpHeaderIDUserAgent, httpHeaderIDCookie, httpHeaderIDAcceptRanges,
  httpHeaderIDAge, httpHeaderIDETag, httpHeaderIDLocation, httpHeaderIDProxyAuthenticate,
  httpHeaderIDRetryAfter, httpHeaderIDServer, httpHeaderIDVary, httpHeaderIDWWWAuthenticate,
  httpHeaderIDSetCookie, httpHeaderIDAuthenticationInfo, httpHeaderIDProxyAuthenticationInfo, httpHeaderIDAllow,
  httpHeaderIDContentEncoding, httpHeaderIDContentDisposition, httpHeaderIDContentLanguage, httpHeaderIDContentLength,
  httpHeaderIDContentLocation, httpHeaderIDContentMD5, httpHeaderIDContentRange, httpHeaderIDContentType,
  httpHeaderIDExpires, httpHeaderIDLastModified, httpHeaderIDRefresh, httpHeaderIDENUMS
}
 Constant for HTTP Header ID. More...
enum  _AlpHttpMethod { httpMethodGET = 1, httpMethodPOST = 3, httpMethodMethods }
 Constant for http method. More...
enum  _AlpHttpScheme { httpSchemeHTTP = 0, httpSchemeHTTPS, httpSchemeSchemes }
 Constant for http stream protocol scheme. More...
enum  _AlpHttpStatusCode {
  httpStatusCodeContinue = 100, httpStatusCodeSwitchingProtocols = 101, httpStatusCodeOK = 200, httpStatusCodeCreated = 201,
  httpStatusCodeAccepted = 202, httpStatusCodeNonAuthoritativeInformation = 203, httpStatusCodeNoContent = 204, httpStatusCodeResetContent = 205,
  httpStatusCodePartialContent = 206, httpStatusCodeMultipleChoices = 300, httpStatusCodeMovedPermanently = 301, httpStatusCodeFound = 302,
  httpStatusCodeSeeOther = 303, httpStatusCodeNotModified = 304, httpStatusCodeUseProxy = 305, httpStatusCodeTemporaryRedirect = 307,
  httpStatusCodeBadRequest = 400, httpStatusCodeUnauthorized = 401, httpStatusCodePaymentRequired = 402, httpStatusCodeForbidden = 403,
  httpStatusCodeNotFound = 404, httpStatusCodeMethodNotAllowed = 405, httpStatusCodeNotAcceptable = 406, httpStatusCodeProxyAuthenticationRequired = 407,
  httpStatusCodeRequestTimeout = 408, httpStatusCodeConflict = 409, httpStatusCodeGone = 410, httpStatusCodeLengthRequired = 411,
  httpStatusCodePreconditionFailed = 412, httpStatusCodeRequestEntityTooLarge = 413, httpStatusCodeRequestURITooLarge = 414, httpStatusCodeUnsupportedMediaType = 415,
  httpStatusCodeRequestedRangeNotSatisfiable = 416, httpStatusCodeExpectationFailed = 417, httpStatusCodeInternalServerError = 500, httpStatusCodeNotImplemented = 501,
  httpStatusCodeBadGateway = 502, httpStatusCodeServiceUnavailable = 503, httpStatusCodeGatewayTimeout = 504, httpStatusCodeHTTPVersionNotSupported = 505
}
 Constant for http status code. More...
enum  _AlpHttpStreamState {
  httpStreamStateNew = 0, httpStreamStateDormant, httpStreamStateReqCreated, httpStreamStateReqResolve,
  httpStreamStateReqResolving, httpStreamStateReqOpen, httpStreamStateReqConnect, httpStreamStateReqConnecting,
  httpStreamStateReqProxyConnect, httpStreamStateReqProxyConnecting, httpStreamStateReqSSLHandShaking, httpStreamStateReqSSLHandShaked,
  httpStreamStateReqSending, httpStreamStateReqSent, httpStreamStateRspHeaderWaiting, httpStreamStateRspContinue,
  httpStreamStateRspHeaderReceiving, httpStreamStateRspHeaderReceived, httpStreamStateRspEntityReceiving, httpStreamStateRspEntityReceived,
  httpStreamStateObsolete, httpStreamStateDelete, httpStreamStateStates
}
 Constant for http stream state. More...
enum  _AlpHttpVersion { httpVersion_0_9 = 0, httpVersion_1_0, httpVersion_1_1, httpVersionVersions }
 Constant for http version. More...


Define Documentation

#define ALP_HTTP_ERROR_DECLARE sys_class_id,
error_id   )     ((alp_status_t)((alp_status_t)(sys_class_id) | (alp_status_t)(error_id) << 16))
 

#define ALP_STATUS_HTTP_CODE_ACCEPTED   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x13)
 

#define ALP_STATUS_HTTP_CODE_BAD_GATEWAY   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x33)
 

#define ALP_STATUS_HTTP_CODE_BAD_REQUEST   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x1F)
 

#define ALP_STATUS_HTTP_CODE_CONFLICT   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x28)
 

#define ALP_STATUS_HTTP_CODE_CONTINUE   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x0F)
 

#define ALP_STATUS_HTTP_CODE_CREATED   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x12)
 

#define ALP_STATUS_HTTP_CODE_EXPECTATION_FAILED   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x30)
 

#define ALP_STATUS_HTTP_CODE_FORBIDDEN   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x22)
 

#define ALP_STATUS_HTTP_CODE_FOUND   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x1A)
 

#define ALP_STATUS_HTTP_CODE_GATEWAY_TIMEOUT   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x35)
 

#define ALP_STATUS_HTTP_CODE_GONE   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x29)
 

#define ALP_STATUS_HTTP_CODE_HTTPVERSION_NOT_SUPPORTED   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x36)
 

#define ALP_STATUS_HTTP_CODE_INTERNAL_SERVER_ERROR   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x31)
 

#define ALP_STATUS_HTTP_CODE_LENTH_REQUIRED   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x2A)
 

#define ALP_STATUS_HTTP_CODE_METHOD_NOT_ALLOWED   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x24)
 

#define ALP_STATUS_HTTP_CODE_MOVE_PERMANENTLY   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x19)
 

#define ALP_STATUS_HTTP_CODE_MULTIPLE_CHOICES   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x18)
 

#define ALP_STATUS_HTTP_CODE_NO_CONTENT   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x15)
 

#define ALP_STATUS_HTTP_CODE_NON_AUTHORITATIVE_INFORMATION   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x14)
 

#define ALP_STATUS_HTTP_CODE_NOT_ACCEPTABLE   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x25)
 

#define ALP_STATUS_HTTP_CODE_NOT_FOUND   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x23)
 

#define ALP_STATUS_HTTP_CODE_NOT_IMPLEMENTED   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x32)
 

#define ALP_STATUS_HTTP_CODE_NOT_MODIFIED   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x1C)
 

#define ALP_STATUS_HTTP_CODE_OK   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x11)
 

#define ALP_STATUS_HTTP_CODE_PARTIAL_CONTENT   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x17)
 

#define ALP_STATUS_HTTP_CODE_PAYMENT_REQUIRED   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x21)
 

#define ALP_STATUS_HTTP_CODE_PRECONDITION_FAILED   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x2B)
 

#define ALP_STATUS_HTTP_CODE_PROXY_AUTHENTICATION_REQUIRED   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x26)
 

#define ALP_STATUS_HTTP_CODE_REQUEST_ENTITY_TOOLARGE   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x2C)
 

#define ALP_STATUS_HTTP_CODE_REQUEST_TIMEOUT   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x27)
 

#define ALP_STATUS_HTTP_CODE_REQUEST_URI_TOOLARGE   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x2D)
 

#define ALP_STATUS_HTTP_CODE_REQUESTED_RANGE_NOT_SATISFIABLE   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x2F)
 

#define ALP_STATUS_HTTP_CODE_RESET_CONTENT   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x16)
 

#define ALP_STATUS_HTTP_CODE_SEE_OTHER   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x1B)
 

#define ALP_STATUS_HTTP_CODE_SERVICE_UNAVAILABLE   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x34)
 

#define ALP_STATUS_HTTP_CODE_SWITCHING_PROTOCOLS   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x10)
 

#define ALP_STATUS_HTTP_CODE_TEMPORARY_REDIRECT   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x1E)
 

#define ALP_STATUS_HTTP_CODE_UNAUTHORIZED   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x20)
 

#define ALP_STATUS_HTTP_CODE_UNSUPPORTED_MEDIATYPE   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x2E)
 

#define ALP_STATUS_HTTP_CODE_USE_PROXY   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x1D)
 

#define ALP_STATUS_HTTP_ERROR_DNS_ERROR   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x09)
 

#define ALP_STATUS_HTTP_ERROR_EOF   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x07)
 

#define ALP_STATUS_HTTP_ERROR_GENERIC   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x01)
 

#define ALP_STATUS_HTTP_ERROR_INVAL   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x06)
 

#define ALP_STATUS_HTTP_ERROR_IOSLEEP   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x03)
 

#define ALP_STATUS_HTTP_ERROR_NO_MEMORY   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x04)
 

#define ALP_STATUS_HTTP_ERROR_NOT_SUPPORTED   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x08)
 

#define ALP_STATUS_HTTP_ERROR_OK   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x00)
 

#define ALP_STATUS_HTTP_ERROR_OTHER_ERROR   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x0E)
 

#define ALP_STATUS_HTTP_ERROR_REQUEST_TIMEDOUT   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x0C)
 

#define ALP_STATUS_HTTP_ERROR_RESPONSE_TIMEDOUT   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x0D)
 

#define ALP_STATUS_HTTP_ERROR_SSL_ERROR   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x0B)
 

#define ALP_STATUS_HTTP_ERROR_STRPIPE   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x05)
 

#define ALP_STATUS_HTTP_ERROR_TCP_ERROR   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x0A)
 

#define ALP_STATUS_HTTP_ERROR_WOULDBLOCK   ALP_HTTP_ERROR_DECLARE(ALP_CLASS_HTTP, 0x02)
 

#define HTTP_FALSE   0
 

#define HTTP_TRUE   (!HTTP_FALSE)
 

#define httpIPAddrTypeV4   4
 

#define httpPostMULTIPART   0x00000004
 

#define httpPostPLAINTEXT   0x00000002
 

#define httpPostURLENCODED   0x00000001
 

#define httpSSLFlagConnTLS   0x00000004
 

#define httpSSLFlagConnV2   0x00000001
 

#define httpSSLFlagConnV2TLS   (httpSSLFlagConnV2 | httpSSLFlagConnTLS)
 

#define httpSSLFlagConnV2V3   (httpSSLFlagConnV2 | httpSSLFlagConnV3)
 

#define httpSSLFlagConnV2V3TLS   (httpSSLFlagConnV2 | httpSSLFlagConnV3 | httpSSLFlagConnTLS)
 

#define httpSSLFlagConnV3   0x00000002
 

#define httpSSLFlagConnV3TLS   (httpSSLFlagConnV3 | httpSSLFlagConnTLS)
 

#define httpStreamRead   0x00000001
 

#define httpStreamReadWrite   (httpStreamRead|httpStreamWrite)
 

#define httpStreamTextCRCR   "\015\015"
 

#define httpStreamTextCRLF   "\015\012"
 

#define httpStreamTextCRLFCRLF   "\015\012\015\012"
 

#define httpStreamTextLFLF   "\012\012"
 

#define httpStreamWrite   0x00000002
 


Typedef Documentation

typedef int(* alp_http_class_notifystateproc)(AlpHttpStreamHandle streamH, AlpHttpURLStr in_url, int in_state, AlpHttpOpaque in_aux)
 

This is a callback function to get AlpHttpStream state.

typedef int(* alp_http_client_certconfirmproc)(AlpHttpSSL in_ssl, AlpHttpClientCertList in_list, AlpHttpOpaque in_aux)
 

This is a callback function to select a client's certlist.

typedef int(* alp_http_cookie_confirmproc)(AlpHttpCookies in_cookies, AlpHttpURLStr in_url, char *in_header, int in_header_len, AlpHttpOpaque in_aux)
 

This is a callback function to confirm whether or not to accept a Cookie.

If the cookie mode is httpCookieNotifyBeforeSet, a cookie is not accept in HTTP library as long as alp_http_class_add_cookie() is explicitly called.

typedef int(* alp_http_server_certconfirmproc)(AlpHttpSSL in_ssl, int in_verify_result, AlpHttpCertList in_list, AlpHttpOpaque in_aux)
 

This is a callback function to confirm whether or not to accept server's certificate.

When an error occurs during server's certificate authentication, this callback function will be called to determine whether to accept the certificate. Using alp_http_class_ssl_servercertconfirm() to pass down the desision.

typedef struct _AlpHttpAuthInfo AlpHttpAuthInfo
 

typedef AlpHttpAuthInfo* AlpHttpAuthInfoHandle
 

typedef enum _AlpHttpAuthTarget AlpHttpAuthTargetEnum
 

typedef enum _AlpHttpAuthType AlpHttpAuthTypeEnum
 

typedef void* AlpHttpCertList
 

typedef void* AlpHttpCertPtr
 

typedef void* AlpHttpClassHandle
 

typedef void* AlpHttpClientCertList
 

typedef enum _AlpHttpCookie AlpHttpCookieEnum
 

typedef void* AlpHttpCookies
 

typedef void* AlpHttpDataHandle
 

typedef struct _AlpHttpDate AlpHttpDate
 

typedef enum _AlpHttpError AlpHttpErrorEnum
 

typedef void* AlpHttpFixedStr
 

typedef enum _AlpHttpHeaderID AlpHttpHeaderIDEnum
 

typedef struct _AlpHttpIPAddr AlpHttpIPAddr
 

typedef enum _AlpHttpMethod AlpHttpMethodEnum
 

typedef void* AlpHttpOpaque
 

typedef enum _AlpHttpScheme AlpHttpSchemeEnum
 

typedef void* AlpHttpSSL
 

typedef void* AlpHttpSSLClassHandle
 

typedef enum _AlpHttpStatusCode AlpHttpStatusCodeEnum
 

typedef void* AlpHttpStreamHandle
 

typedef enum _AlpHttpStreamState AlpHttpStreamStateEnum
 

typedef void* AlpHttpString
 

typedef struct _AlpHttpStrSplit AlpHttpStrSplit
 

typedef void* AlpHttpURLStr
 

typedef enum _AlpHttpVersion AlpHttpVersionEnum
 

typedef void* AlpHttpVHandle
 


Enumeration Type Documentation

anonymous enum
 

Const for DNS mode.

Enumerator:
httpDNSModeIPV4Only  IPv4.

anonymous enum
 

Constants for Certificate's Attribute.

Enumerator:
httpCertDNCountryName  Country Name.
httpCertDNStateOrProvinceName  State or Province Name.
httpCertDNLocalityName  Locality Name.
httpCertDNStreetAddress  Street Address.
httpCertDNOrganizationName  Organization Name.
httpCertDNOrganizationUnitName  Organization Unit Name.
httpCertDNCommonName  Common Name.
httpCertDNEmailAddress  Email Address.
httpCertDNAttributs 

anonymous enum
 

Constants for CertList Type.

Enumerator:
httpCertListTypeUnknown 
httpCertListTypeServer 
httpCertListTypeClient 
httpCertListTypeBrowser 
httpCertListTypeTypes 

anonymous enum
 

Constans for CertList error type.

Enumerator:
httpCertListEOK 
httpCertListEGeneric 
httpCertListENoMem 
httpCertListESame 
httpCertListEDecode 
httpCertListEFull 

enum _AlpHttpAuthTarget
 

Const for HTTP Access Authentication target.

HTTP access authentication is explained in "HTTP Authentication: Basic and Digest Access Authenticatoin"(RFC2617)

Enumerator:
httpAuthTargetPage  Page.
httpAuthTargetProxy  Proxy.
httpAuthTargetTargets 

enum _AlpHttpAuthType
 

Const for HTTP Authentication type.

HTTP access authentication is explained in "HTTP Authentication: Basic and Digest Access Authenticatoin"(RFC2617)

Enumerator:
httpAuthTypeNone  None.
httpAuthTypeBasic  Basic Access Authentication.
httpAuthTypeDigest  Digest Access Authentication.
httpAuthTypeTypes 

enum _AlpHttpCookie
 

Constant for cookie mode.

Enumerator:
httpCookieNotifyBeforeSet  Notify app before set cookie.
httpCookieAlwaysSet  Always set cookie.
httpCookieNeverSet  Never set cookie.

enum _AlpHttpError
 

Constant for HTTP Library APIs error return code.

Enumerator:
httpErrorOK 
httpErrorGeneric 
httpErrorWouldBlock 
httpErrorIOSleep 
httpErrorNoMem 
httpErrorStrPipe 
httpErrorInval 
httpErrorEOF 
httpErrorNotSupported 
httpErrorDNSInval 
httpErrorDNSNoServer 
httpErrorDNSTimedout 
httpErrorDNSNotFound 
httpErrorTCPOpen 
httpErrorTCPConnect 
httpErrorTCPRead 
httpErrorTCPWrite 
httpErrorSSLConnect 
httpErrorSSLHandShake 
httpErrorSSLRead 
httpErrorSSLWrite 
httpErrorReqTimedout 
httpErrorRspTimedout 
httpErrorCacheNone 
httpErrorCacheExpire 
httpErrorAuthUnknown 
httpErrorAuthNoHeader 
httpErrorAuthFormat 
httpErrorAuthIgnored 
httpErrorRedirectFormat 
httpErrorRedirectCanceled 
httpErrorRedirectIgnored 
httpErrorReqHeaderSizeOver  method GET
httpErrorReqBodySizeOver  method POST
httpErrorRspHeaderSizeOver 
httpErrorReqTooManyContinue 
httpErrorTLSIntolerant 

enum _AlpHttpHeaderID
 

Constant for HTTP Header ID.

Enumerator:
httpHeaderIDCacheControl  Cache-Control.
httpHeaderIDConnection  Connection.
httpHeaderIDDate  Date.
httpHeaderIDPragma  Pragma.
httpHeaderIDTrailer  Trailer.
httpHeaderIDTransferEncoding  Transfer-Encoding.
httpHeaderIDUpgrade  Upgrade.
httpHeaderIDVia  Via.
httpHeaderIDWarning  Warning.
httpHeaderIDKeepAlive 
httpHeaderIDProxyConnection 
httpHeaderIDAccept  Accept.
httpHeaderIDAcceptCharset  Accept-Charset.
httpHeaderIDAcceptEncoding  Accept-Encoding.
httpHeaderIDAcceptLanguage  Accept-Language.
httpHeaderIDAuthorization  Authorization.
httpHeaderIDExpect  Expect.
httpHeaderIDFrom  Form.
httpHeaderIDHost  Host.
httpHeaderIDIfMatch  If-Match.
httpHeaderIDIfModifiedSince  If-Modified-Since.
httpHeaderIDIfNoneMatch  If-None-Match.
httpHeaderIDIfRange  If-Range.
httpHeaderIDIfUnmodifiedSince  If-Unmodified-Since.
httpHeaderIDMaxForwards  Max-Forwards.
httpHeaderIDProxyAuthorization  Proxy-Authorization.
httpHeaderIDRange  Range.
httpHeaderIDReferer  Referer.
httpHeaderIDTE  TE.
httpHeaderIDUserAgent  User-Agent.
httpHeaderIDCookie  Cookie.
httpHeaderIDAcceptRanges  Accept-Range.
httpHeaderIDAge  Age.
httpHeaderIDETag  ETag.
httpHeaderIDLocation  Location.
httpHeaderIDProxyAuthenticate  Proxy-Authenticate.
httpHeaderIDRetryAfter  Retry-Afer.
httpHeaderIDServer  Server.
httpHeaderIDVary  Vary.
httpHeaderIDWWWAuthenticate  WWW-Authenticate.
httpHeaderIDSetCookie  Set-Cookie.
httpHeaderIDAuthenticationInfo  Authenticaion-Info.
httpHeaderIDProxyAuthenticationInfo 
httpHeaderIDAllow  Allow.
httpHeaderIDContentEncoding  Content-Encoding.
httpHeaderIDContentDisposition 
httpHeaderIDContentLanguage  Content-Language.
httpHeaderIDContentLength  Content-Length.
httpHeaderIDContentLocation  Content-Location.
httpHeaderIDContentMD5  Content-MD5.
httpHeaderIDContentRange  Content-Range.
httpHeaderIDContentType  Content-Type.
httpHeaderIDExpires  Expires.
httpHeaderIDLastModified  Last-Modified.
httpHeaderIDRefresh 
httpHeaderIDENUMS 

enum _AlpHttpMethod
 

Constant for http method.

Enumerator:
httpMethodGET  GET.
httpMethodPOST  POST.
httpMethodMethods 

enum _AlpHttpScheme
 

Constant for http stream protocol scheme.

Enumerator:
httpSchemeHTTP 
httpSchemeHTTPS 
httpSchemeSchemes 

enum _AlpHttpStatusCode
 

Constant for http status code.

1xx: Informational- Request received, continuing process 2xx: Success- The action was successfully received, understood, and accepted 3xx: Redirection- Further action must be taken in order to complete the request 4xx: Client Error- The request contains bad syntax or cannot be fulfilled 5xx: Server Error- Teh server failed to fulfill an apparently valid request For more detail information, please refer to RFC2616, section 10 (Status Code Definitions)

Enumerator:
httpStatusCodeContinue 
httpStatusCodeSwitchingProtocols 
httpStatusCodeOK 
httpStatusCodeCreated 
httpStatusCodeAccepted 
httpStatusCodeNonAuthoritativeInformation 
httpStatusCodeNoContent 
httpStatusCodeResetContent 
httpStatusCodePartialContent 
httpStatusCodeMultipleChoices 
httpStatusCodeMovedPermanently 
httpStatusCodeFound 
httpStatusCodeSeeOther 
httpStatusCodeNotModified 
httpStatusCodeUseProxy 
httpStatusCodeTemporaryRedirect 
httpStatusCodeBadRequest 
httpStatusCodeUnauthorized 
httpStatusCodePaymentRequired 
httpStatusCodeForbidden 
httpStatusCodeNotFound 
httpStatusCodeMethodNotAllowed 
httpStatusCodeNotAcceptable 
httpStatusCodeProxyAuthenticationRequired 
httpStatusCodeRequestTimeout 
httpStatusCodeConflict 
httpStatusCodeGone 
httpStatusCodeLengthRequired 
httpStatusCodePreconditionFailed 
httpStatusCodeRequestEntityTooLarge 
httpStatusCodeRequestURITooLarge 
httpStatusCodeUnsupportedMediaType 
httpStatusCodeRequestedRangeNotSatisfiable 
httpStatusCodeExpectationFailed 
httpStatusCodeInternalServerError 
httpStatusCodeNotImplemented 
httpStatusCodeBadGateway 
httpStatusCodeServiceUnavailable 
httpStatusCodeGatewayTimeout 
httpStatusCodeHTTPVersionNotSupported 

enum _AlpHttpStreamState
 

Constant for http stream state.

Enumerator:
httpStreamStateNew 
httpStreamStateDormant 
httpStreamStateReqCreated 
httpStreamStateReqResolve 
httpStreamStateReqResolving 
httpStreamStateReqOpen 
httpStreamStateReqConnect 
httpStreamStateReqConnecting 
httpStreamStateReqProxyConnect 
httpStreamStateReqProxyConnecting 
httpStreamStateReqSSLHandShaking 
httpStreamStateReqSSLHandShaked 
httpStreamStateReqSending 
httpStreamStateReqSent 
httpStreamStateRspHeaderWaiting 
httpStreamStateRspContinue 
httpStreamStateRspHeaderReceiving 
httpStreamStateRspHeaderReceived 
httpStreamStateRspEntityReceiving 
httpStreamStateRspEntityReceived 
httpStreamStateObsolete 
httpStreamStateDelete 
httpStreamStateStates 

enum _AlpHttpVersion
 

Constant for http version.

Enumerator:
httpVersion_0_9  HTTP/0.9.
httpVersion_1_0  HTTP/1.0.
httpVersion_1_1  HTTP/1.1.
httpVersionVersions 


Generated on Wed Jul 30 07:06:42 2008 by Doxygen 1.4.6 for ALP SDK + Hiker Documentation

Copyright © 1999-2008 ACCESS CO., LTD. All rights reserved.