THRIFT-4535: XML docs; code cleanup (tabs->spaces; String->string)
Client: C#
Patch: Christian Weiss
This closes #1524
diff --git a/lib/csharp/src/Protocol/TMultiplexedProcessor.cs b/lib/csharp/src/Protocol/TMultiplexedProcessor.cs
index 35d138c..aa91c52 100644
--- a/lib/csharp/src/Protocol/TMultiplexedProcessor.cs
+++ b/lib/csharp/src/Protocol/TMultiplexedProcessor.cs
@@ -29,74 +29,77 @@
namespace Thrift.Protocol
{
-
- /**
- * TMultiplexedProcessor is a TProcessor allowing a single TServer to provide multiple services.
- * To do so, you instantiate the processor and then register additional processors with it,
- * as shown in the following example:
- *
- * TMultiplexedProcessor processor = new TMultiplexedProcessor();
- *
- * processor.registerProcessor(
- * "Calculator",
- * new Calculator.Processor(new CalculatorHandler()));
- *
- * processor.registerProcessor(
- * "WeatherReport",
- * new WeatherReport.Processor(new WeatherReportHandler()));
- *
- * TServerTransport t = new TServerSocket(9090);
- * TSimpleServer server = new TSimpleServer(processor, t);
- *
- * server.serve();
- */
+ /// <summary>
+ /// <see cref="TMultiplexedProcessor"/> is a <see cref="TProcessor"/> allowing a single <see cref="Thrift.Server.TServer"/>
+ /// to provide multiple services.
+ /// <para/>
+ /// To do so, you instantiate the processor and then register additional processors with it,
+ /// as shown in the following example:
+ /// <para/>
+ /// <code>
+ /// TMultiplexedProcessor processor = new TMultiplexedProcessor();
+ ///
+ /// processor.registerProcessor(
+ /// "Calculator",
+ /// new Calculator.Processor(new CalculatorHandler()));
+ ///
+ /// processor.registerProcessor(
+ /// "WeatherReport",
+ /// new WeatherReport.Processor(new WeatherReportHandler()));
+ ///
+ /// TServerTransport t = new TServerSocket(9090);
+ /// TSimpleServer server = new TSimpleServer(processor, t);
+ ///
+ /// server.serve();
+ /// </code>
+ /// </summary>
public class TMultiplexedProcessor : TProcessor
{
- private Dictionary<String,TProcessor> ServiceProcessorMap = new Dictionary<String,TProcessor>();
+ private Dictionary<string, TProcessor> ServiceProcessorMap = new Dictionary<string, TProcessor>();
- /**
- * 'Register' a service with this TMultiplexedProcessor. This allows us to broker
- * requests to individual services by using the service name to select them at request time.
- *
- * Args:
- * - serviceName Name of a service, has to be identical to the name
- * declared in the Thrift IDL, e.g. "WeatherReport".
- * - processor Implementation of a service, usually referred to as "handlers",
- * e.g. WeatherReportHandler implementing WeatherReport.Iface.
- */
- public void RegisterProcessor(String serviceName, TProcessor processor)
+ /// <summary>
+ /// 'Register' a service with this TMultiplexedProcessor. This allows us to broker
+ /// requests to individual services by using the service name to select them at request time.
+ ///
+ /// Args:
+ /// - serviceName Name of a service, has to be identical to the name
+ /// declared in the Thrift IDL, e.g. "WeatherReport".
+ /// - processor Implementation of a service, usually referred to as "handlers",
+ /// e.g. WeatherReportHandler implementing WeatherReport.Iface.
+ /// </summary>
+ public void RegisterProcessor(string serviceName, TProcessor processor)
{
ServiceProcessorMap.Add(serviceName, processor);
}
- private void Fail( TProtocol oprot, TMessage message, TApplicationException.ExceptionType extype, string etxt)
+ private void Fail(TProtocol oprot, TMessage message, TApplicationException.ExceptionType extype, string etxt)
{
- TApplicationException appex = new TApplicationException( extype, etxt);
+ TApplicationException appex = new TApplicationException(extype, etxt);
TMessage newMessage = new TMessage(message.Name, TMessageType.Exception, message.SeqID);
oprot.WriteMessageBegin(newMessage);
- appex.Write( oprot);
+ appex.Write(oprot);
oprot.WriteMessageEnd();
oprot.Transport.Flush();
}
- /**
- * This implementation of process performs the following steps:
- *
- * - Read the beginning of the message.
- * - Extract the service name from the message.
- * - Using the service name to locate the appropriate processor.
- * - Dispatch to the processor, with a decorated instance of TProtocol
- * that allows readMessageBegin() to return the original TMessage.
- *
- * Throws an exception if
- * - the message type is not CALL or ONEWAY,
- * - the service name was not found in the message, or
- * - the service name has not been RegisterProcessor()ed.
- */
+ /// <summary>
+ /// This implementation of process performs the following steps:
+ ///
+ /// - Read the beginning of the message.
+ /// - Extract the service name from the message.
+ /// - Using the service name to locate the appropriate processor.
+ /// - Dispatch to the processor, with a decorated instance of TProtocol
+ /// that allows readMessageBegin() to return the original TMessage.
+ /// <para/>
+ /// Throws an exception if
+ /// - the message type is not CALL or ONEWAY,
+ /// - the service name was not found in the message, or
+ /// - the service name has not been RegisterProcessor()ed.
+ /// </summary>
public bool Process(TProtocol iprot, TProtocol oprot)
{
/* Use the actual underlying protocol (e.g. TBinaryProtocol) to read the
@@ -155,17 +158,17 @@
}
- /**
- * Our goal was to work with any protocol. In order to do that, we needed
- * to allow them to call readMessageBegin() and get a TMessage in exactly
- * the standard format, without the service name prepended to TMessage.name.
- */
+ /// <summary>
+ /// Our goal was to work with any protocol. In order to do that, we needed
+ /// to allow them to call readMessageBegin() and get a TMessage in exactly
+ /// the standard format, without the service name prepended to TMessage.name.
+ /// </summary>
private class StoredMessageProtocol : TProtocolDecorator
{
TMessage MsgBegin;
public StoredMessageProtocol(TProtocol protocol, TMessage messageBegin)
- :base(protocol)
+ : base(protocol)
{
this.MsgBegin = messageBegin;
}