MonoRail/Castle.MonoRail.Framework/IAsyncController.cs

   1 namespace Castle.MonoRail.Framework
   2 {
   3         using System;
   4
   5         /// <summary>
   6         /// Represent the core functionality required out of a controller
   7         /// that wants to support async actions
   8         /// </summary>
   9         public interface IAsyncController : IController
  10         {
  11                 /// <summary>
  12                 /// Begin to perform the specified async action, which means:
  13                 /// <br/>
  14                 /// 1. Define the default view name<br/>
  15                 /// 2. Run the before filters<br/>
  16                 /// 3. Select the begin method related to the action name and invoke it<br/>
  17                 /// 4. Return the result of the async method start and let ASP.Net wait on it
  18                 /// </summary>
  19                 /// <param name="engineContext">The engine context.</param>
  20                 /// <param name="context">The controller context.</param>
  21                 /// <remarks>
  22                 /// The async infomrmation about this call is pass using the controller context Async property
  23                 /// </remarks>
  24                 IAsyncResult BeginProcess(IEngineContext engineContext, IControllerContext context);
  25
  26                 /// <summary>
  27                 /// Complete processing of the request:<br/>
  28                 /// 1. Execute end method related to the action name<br/>
  29                 /// 2. On error, execute the rescues if available<br/>
  30                 /// 3. Run the after filters<br/>
  31                 /// 4. Invoke the view engine<br/>
  32                 /// </summary>
  33                 /// <remarks>
  34                 /// The async infomrmation about this call is pass using the controller context Async property
  35                 /// </remarks>
  36                 void EndProcess();
  37         }
  38 }