ceph/src/jaegertracing/thrift/lib/netstd/Thrift/Server/TServerEventHandler.cs

   1 // Licensed to the Apache Software Foundation(ASF) under one
   2 // or more contributor license agreements.See the NOTICE file
   3 // distributed with this work for additional information
   4 // regarding copyright ownership.The ASF licenses this file
   5 // to you under the Apache License, Version 2.0 (the
   6 // "License"); you may not use this file except in compliance
   7 // with the License. You may obtain a copy of the License at
   8 //
   9 //     http://www.apache.org/licenses/LICENSE-2.0
  10 //
  11 // Unless required by applicable law or agreed to in writing,
  12 // software distributed under the License is distributed on an
  13 // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  14 // KIND, either express or implied. See the License for the
  15 // specific language governing permissions and limitations
  16 // under the License.
  17
  18 using System.Threading;
  19 using System.Threading.Tasks;
  20 using Thrift.Protocol;
  21 using Thrift.Transport;
  22
  23 namespace Thrift.Server
  24 {
  25     //TODO: replacement by event?
  26
  27     /// <summary>
  28     ///     Interface implemented by server users to handle events from the server
  29     /// </summary>
  30     // ReSharper disable once InconsistentNaming
  31     public interface TServerEventHandler
  32     {
  33         /// <summary>
  34         ///     Called before the server begins */
  35         /// </summary>
  36         Task PreServeAsync(CancellationToken cancellationToken);
  37
  38         /// <summary>
  39         ///     Called when a new client has connected and is about to being processing */
  40         /// </summary>
  41         Task<object> CreateContextAsync(TProtocol input, TProtocol output, CancellationToken cancellationToken);
  42
  43         /// <summary>
  44         ///     Called when a client has finished request-handling to delete server context */
  45         /// </summary>
  46         Task DeleteContextAsync(object serverContext, TProtocol input, TProtocol output,
  47             CancellationToken cancellationToken);
  48
  49         /// <summary>
  50         ///     Called when a client is about to call the processor */
  51         /// </summary>
  52         Task ProcessContextAsync(object serverContext, TTransport transport, CancellationToken cancellationToken);
  53     }
  54 }