Skip to content
Snippets Groups Projects
  • Don Kjer's avatar
    f9454152
    Large changes to the LLCurl::Responder API, as well as pulling in some changes... · f9454152
    Don Kjer authored
    Large changes to the LLCurl::Responder API, as well as pulling in some changes to common libraries from the server codebase:
    
    * Additional error checking in http handlers.
    * Uniform log spam for http errors.
    * Switch to using constants for http heads and status codes.
    * Fixed bugs in incorrectly checking if parsing LLSD xml resulted in an error.
    * Reduced spam regarding LLSD parsing errors in the default completedRaw http handler.  It should not longer be necessary to short-circuit completedRaw to avoid spam.
    * Ported over a few bug fixes from the server code.
    * Switch mode http status codes to use S32 instead of U32.
    * Ported LLSD::asStringRef from server code; avoids copying strings all over the place.
    * Ported server change to LLSD::asBinary; this always returns a reference now instead of copying the entire binary blob.
    * Ported server pretty notation format (and pretty binary format) to llsd serialization.
    
    * The new LLCurl::Responder API no longer has two error handlers to choose from.  Overriding the following methods have been deprecated:
    ** error - use httpFailure
    ** errorWithContent - use httpFailure
    ** result - use httpSuccess
    ** completed - use httpCompleted
    ** completedHeader - no longer necessary; call getResponseHeaders() from a completion method to obtain these headers.
    
    * In order to 'catch' a completed http request, override one of these methods:
    ** httpSuccess - Called for any 2xx status code.
    ** httpFailure - Called for any non-2xx status code.
    ** httpComplete - Called for all status codes.  Default implementation is to call either httpSuccess or httpFailure.
    * It is recommended to keep these methods protected/private in order to avoid triggering of these methods without using a 'push' method (see below).
    
    * Uniform error handling should followed whenever possible by calling a variant of this during httpFailure:
    ** llwarns << dumpResponse() << llendl;
    * Be sure to include LOG_CLASS(your_class_name) in your class in order for the log entry to give more context.
    
    * In order to 'push' a result into the responder, you should no longer call error, errorWithContent, result, or completed.
    * Nor should you directly call httpSuccess/Failure/Completed (unless passing a message up to a parent class).
    * Instead, you can set the internal content of a responder and trigger a corresponding method using the following methods:
    ** successResult - Sets results and calls httpSuccess
    ** failureResult - Sets results and calls httpFailure
    ** completedResult - Sets results and calls httpCompleted
    
    * To obtain information about a the response from a reponder method, use the following getters:
    ** getStatus - HTTP status code
    ** getReason - Reason string
    ** getContent - Content (Parsed body LLSD)
    ** getResponseHeaders - Response Headers (LLSD map)
    ** getHTTPMethod - HTTP method of the request
    ** getURL - URL of the request
    
    * It is still possible to override completeRaw if you want to manipulate data directly out of LLPumpIO.
    
    * See indra/llmessage/llcurl.h for more information.
    f9454152
    History
    Large changes to the LLCurl::Responder API, as well as pulling in some changes...
    Don Kjer authored
    Large changes to the LLCurl::Responder API, as well as pulling in some changes to common libraries from the server codebase:
    
    * Additional error checking in http handlers.
    * Uniform log spam for http errors.
    * Switch to using constants for http heads and status codes.
    * Fixed bugs in incorrectly checking if parsing LLSD xml resulted in an error.
    * Reduced spam regarding LLSD parsing errors in the default completedRaw http handler.  It should not longer be necessary to short-circuit completedRaw to avoid spam.
    * Ported over a few bug fixes from the server code.
    * Switch mode http status codes to use S32 instead of U32.
    * Ported LLSD::asStringRef from server code; avoids copying strings all over the place.
    * Ported server change to LLSD::asBinary; this always returns a reference now instead of copying the entire binary blob.
    * Ported server pretty notation format (and pretty binary format) to llsd serialization.
    
    * The new LLCurl::Responder API no longer has two error handlers to choose from.  Overriding the following methods have been deprecated:
    ** error - use httpFailure
    ** errorWithContent - use httpFailure
    ** result - use httpSuccess
    ** completed - use httpCompleted
    ** completedHeader - no longer necessary; call getResponseHeaders() from a completion method to obtain these headers.
    
    * In order to 'catch' a completed http request, override one of these methods:
    ** httpSuccess - Called for any 2xx status code.
    ** httpFailure - Called for any non-2xx status code.
    ** httpComplete - Called for all status codes.  Default implementation is to call either httpSuccess or httpFailure.
    * It is recommended to keep these methods protected/private in order to avoid triggering of these methods without using a 'push' method (see below).
    
    * Uniform error handling should followed whenever possible by calling a variant of this during httpFailure:
    ** llwarns << dumpResponse() << llendl;
    * Be sure to include LOG_CLASS(your_class_name) in your class in order for the log entry to give more context.
    
    * In order to 'push' a result into the responder, you should no longer call error, errorWithContent, result, or completed.
    * Nor should you directly call httpSuccess/Failure/Completed (unless passing a message up to a parent class).
    * Instead, you can set the internal content of a responder and trigger a corresponding method using the following methods:
    ** successResult - Sets results and calls httpSuccess
    ** failureResult - Sets results and calls httpFailure
    ** completedResult - Sets results and calls httpCompleted
    
    * To obtain information about a the response from a reponder method, use the following getters:
    ** getStatus - HTTP status code
    ** getReason - Reason string
    ** getContent - Content (Parsed body LLSD)
    ** getResponseHeaders - Response Headers (LLSD map)
    ** getHTTPMethod - HTTP method of the request
    ** getURL - URL of the request
    
    * It is still possible to override completeRaw if you want to manipulate data directly out of LLPumpIO.
    
    * See indra/llmessage/llcurl.h for more information.
Code owners
Assign users and groups as approvers for specific file changes. Learn more.