Skip to content

Order of Operations

Jump to bottom Edit New page
Demis Bellot edited this page Feb 21, 2014 · 14 revisions

HTTP Custom hooks

This list shows the order in which any user-defined custom hooks are executed:

  1. HostContext.RawHttpHandlers are executed before anything else, i.e. returning any ASP.NET IHttpHandler by-passes ServiceStack completely and processes your custom IHttpHandler instead.
  2. If the Request doesn't match any existing Routes it will search IAppHost.CatchAllHandlers for a match
  3. The IAppHost.PreRequestFilters gets executed before the Request DTO is deserialized
  4. Default Request DTO Binding or Custom Request Binding (if registered)
  5. Request Filter Attributes with Priority < 0 gets executed
  6. Then any Global Request Filters get executed
  7. Followed by Request Filter Attributes with Priority >= 0
  8. Action Request Filters
  9. Then your Service is executed with the configured IServiceRunner and its OnBeforeExecute, OnAfterExecute and HandleException custom hooks are fired
  10. Action Response Filters
  11. Followed by Response Filter Attributes with Priority < 0
  12. Then Global Response Filters
  13. Followed by Response Filter Attributes with Priority >= 0
  14. Finally at the end of the Request IAppHost.OnEndRequest is fired

Any time you close the Response in any of your filters, i.e. httpRes.EndRequest() the processing of the response is short-circuited and no further processing is done on that request.

MQ (non-HTTP) Custom hooks

  1. Any Global Request Filters get executed
  2. Followed by Request Filter Attributes with Priority >= 0
  3. Action Request Filters
  4. Then your Service is executed with the configured IServiceRunner and its OnBeforeExecute, OnAfterExecute and HandleException custom hooks are fired
  5. Action Response Filters
  6. Then Global Response Filters
  7. Finally at the end of the Request IAppHost.OnEndRequest is fired

Implementation architecture diagram

The Implementation architecture diagram shows a visual cue of the internal order of operations that happens in ServiceStack:

ServiceStack Overview

After the IHttpHandler is returned, it gets executed with the current ASP.NET or HttpListener request wrapped in a common IHttpRequest instance.

The implementation of RestHandler shows what happens during a typical ServiceStack request:

ServiceStack Request Pipeline

Add a custom footer
  1. Getting Started
    1. Create your first webservice
    2. Your first webservice explained
    3. ServiceStack's new API Design
    4. Designing a REST-ful service with ServiceStack
    5. Example Projects Overview
  2. Reference
    1. Order of Operations
    2. The IoC container
    3. Metadata page
    4. Rest, SOAP & default endpoints
    5. SOAP support
    6. Routing
    7. Service return types
    8. Customize HTTP Responses
    9. Plugins
    10. Validation
    11. Error Handling
    12. Security
    13. Debugging
  3. Clients
    1. Overview
    2. C# client
    3. Silverlight client
    4. JavaScript client
    5. Dart Client
    6. MQ Clients
  4. Formats
    1. Overview
    2. JSON/JSV and XML
    3. ServiceStack's new HTML5 Report Format
    4. ServiceStack's new CSV Format
    5. MessagePack Format
    6. ProtoBuf Format
  5. View Engines 4. Razor & Markdown Razor
    1. Markdown Razor
  6. Hosts
    1. IIS
    2. Self-hosting
    3. Messaging
    4. Mono
  7. Security
    1. Authentication/authorization
    2. Sessions
    3. Restricting Services
  8. Advanced
    1. Configuration options
    2. Access HTTP specific features in services
    3. Logging
    4. Serialization/deserialization
    5. Request/response filters
    6. Filter attributes
    7. Concurrency Model
    8. Built-in caching options
    9. Built-in profiling
    10. Form Hijacking Prevention
    11. Auto-Mapping
    12. HTTP Utils
    13. Virtual File System
    14. Config API
    15. Physical Project Structure
    16. Modularizing Services
    17. MVC Integration
  9. Plugins 3. Request logger 4. Swagger API
  10. Tests
    1. Testing
    2. HowTo write unit/integration tests
  11. Other Languages
    1. FSharp
    2. VB.NET
  12. Use Cases
    1. Single Page Apps
    2. Azure
    3. Logging
    4. Bundling and Minification
    5. NHibernate
  13. Performance
    1. Real world performance
  14. How To
    1. Sending stream to ServiceStack
    2. Setting UserAgent in ServiceStack JsonServiceClient
    3. ServiceStack adding to allowed file extensions
    4. Default web service page how to
  15. Future
    1. Roadmap

Clone this wiki locally