mcs/class/System.ServiceModel/System.ServiceModel.Dispatcher/ChannelDispatcher.cs

   1 //
   2 // ChannelDispatcher.cs
   3 //
   4 // Author:
   5 //      Atsushi Enomoto <atsushi@ximian.com>
   6 //
   7 // Copyright (C) 2005,2009 Novell, Inc.  http://www.novell.com
   8 //
   9 // Permission is hereby granted, free of charge, to any person obtaining
  10 // a copy of this software and associated documentation files (the
  11 // "Software"), to deal in the Software without restriction, including
  12 // without limitation the rights to use, copy, modify, merge, publish,
  13 // distribute, sublicense, and/or sell copies of the Software, and to
  14 // permit persons to whom the Software is furnished to do so, subject to
  15 // the following conditions:
  16 //
  17 // The above copyright notice and this permission notice shall be
  18 // included in all copies or substantial portions of the Software.
  19 //
  20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  24 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  25 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  26 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  27 //
  28 using System;
  29 using System.Collections.Generic;
  30 using System.Collections.ObjectModel;
  31 using System.Reflection;
  32 using System.ServiceModel.Channels;
  33 using System.Threading;
  34 using System.Transactions;
  35 using System.ServiceModel;
  36 using System.ServiceModel.Description;
  37
  38 namespace System.ServiceModel.Dispatcher
  39 {
  40         public class ChannelDispatcher : ChannelDispatcherBase
  41         {
  42                 class EndpointDispatcherCollection : SynchronizedCollection<EndpointDispatcher>
  43                 {
  44                         public EndpointDispatcherCollection (ChannelDispatcher owner)
  45                         {
  46                                 this.owner = owner;
  47                         }
  48
  49                         ChannelDispatcher owner;
  50
  51                         protected override void ClearItems ()
  52                         {
  53                                 foreach (var ed in this)
  54                                         ed.ChannelDispatcher = null;
  55                                 base.ClearItems ();
  56                         }
  57
  58                         protected override void InsertItem (int index, EndpointDispatcher item)
  59                         {
  60                                 item.ChannelDispatcher = owner;
  61                                 base.InsertItem (index, item);
  62                         }
  63
  64                         protected virtual void RemoveItem (int index)
  65                         {
  66                                 if (index < Count)
  67                                         this [index].ChannelDispatcher = null;
  68                                 base.RemoveItem (index);
  69                         }
  70
  71                         protected virtual void SetItem (int index, EndpointDispatcher item)
  72                         {
  73                                 item.ChannelDispatcher = owner;
  74                                 base.SetItem (index, item);
  75                         }
  76                 }
  77
  78                 ServiceHostBase host;
  79
  80                 string binding_name;
  81                 Collection<IErrorHandler> error_handlers
  82                         = new Collection<IErrorHandler> ();
  83                 IChannelListener listener;
  84                 internal IDefaultCommunicationTimeouts timeouts; // FIXME: remove internal
  85                 MessageVersion message_version;
  86                 bool receive_sync, include_exception_detail_in_faults,
  87                         manual_addressing, is_tx_receive;
  88                 int max_tx_batch_size;
  89                 SynchronizedCollection<IChannelInitializer> initializers
  90                         = new SynchronizedCollection<IChannelInitializer> ();
  91                 IsolationLevel tx_isolation_level;
  92                 TimeSpan tx_timeout;
  93                 ServiceThrottle throttle;
  94
  95                 Guid identifier = Guid.NewGuid ();
  96                 ManualResetEvent async_event = new ManualResetEvent (false);
  97
  98                 ListenerLoopManager loop_manager;
  99                 SynchronizedCollection<EndpointDispatcher> endpoints;
 100
 101                 [MonoTODO ("get binding info from config")]
 102                 public ChannelDispatcher (IChannelListener listener)
 103                         : this (listener, null)
 104                 {
 105                 }
 106
 107                 public ChannelDispatcher (
 108                         IChannelListener listener, string bindingName)
 109                         : this (listener, bindingName, null)
 110                 {
 111                 }
 112
 113                 public ChannelDispatcher (
 114                         IChannelListener listener, string bindingName,
 115                         IDefaultCommunicationTimeouts timeouts)
 116                 {
 117                         if (listener == null)
 118                                 throw new ArgumentNullException ("listener");
 119                         Init (listener, bindingName, timeouts);
 120                 }
 121
 122                 private void Init (IChannelListener listener, string bindingName,
 123                         IDefaultCommunicationTimeouts timeouts)
 124                 {
 125                         this.listener = listener;
 126                         this.binding_name = bindingName;
 127                         // IChannelListener is often a ChannelListenerBase
 128                         // which implements IDefaultCommunicationTimeouts.
 129                         this.timeouts = timeouts ?? listener as IDefaultCommunicationTimeouts ?? DefaultCommunicationTimeouts.Instance;
 130                         endpoints = new EndpointDispatcherCollection (this);
 131                 }
 132
 133                 internal void InitializeServiceEndpoint (Type serviceType, ServiceEndpoint se)
 134                 {
 135                         this.MessageVersion = se.Binding.MessageVersion;
 136                         if (this.MessageVersion == null)
 137                                 this.MessageVersion = MessageVersion.Default;
 138
 139                         //Attach one EndpointDispacher to the ChannelDispatcher
 140                         EndpointDispatcher ed = new EndpointDispatcher (se.Address, se.Contract.Name, se.Contract.Namespace);
 141                         this.Endpoints.Add (ed);
 142                         ed.InitializeServiceEndpoint (false, serviceType, se);
 143                 }
 144
 145                 public string BindingName {
 146                         get { return binding_name; }
 147                 }
 148
 149                 public SynchronizedCollection<IChannelInitializer> ChannelInitializers {
 150                         get { return initializers; }
 151                 }
 152
 153                 protected internal override TimeSpan DefaultCloseTimeout {
 154                         get { return timeouts.CloseTimeout; }
 155                 }
 156
 157                 protected internal override TimeSpan DefaultOpenTimeout {
 158                         get { return timeouts.OpenTimeout; }
 159                 }
 160
 161                 public Collection<IErrorHandler> ErrorHandlers {
 162                         get { return error_handlers; }
 163                 }
 164
 165                 public SynchronizedCollection<EndpointDispatcher> Endpoints {
 166                         get { return endpoints; }
 167                 }
 168
 169                 [MonoTODO]
 170                 public bool IsTransactedAccept {
 171                         get { throw new NotImplementedException (); }
 172                 }
 173
 174                 public bool IsTransactedReceive {
 175                         get { return is_tx_receive; }
 176                         set { is_tx_receive = value; }
 177                 }
 178
 179                 public bool ManualAddressing {
 180                         get { return manual_addressing; }
 181                         set { manual_addressing = value; }
 182                 }
 183
 184                 public int MaxTransactedBatchSize {
 185                         get { return max_tx_batch_size; }
 186                         set { max_tx_batch_size = value; }
 187                 }
 188
 189                 public override ServiceHostBase Host {
 190                         get { return host; }
 191                 }
 192
 193                 public override IChannelListener Listener {
 194                         get { return listener; }
 195                 }
 196
 197                 public MessageVersion MessageVersion {
 198                         get { return message_version; }
 199                         set { message_version = value; }
 200                 }
 201
 202                 public bool ReceiveSynchronously {
 203                         get { return receive_sync; }
 204                         set {
 205                                 ThrowIfDisposedOrImmutable ();
 206                                 receive_sync = value;
 207                         }
 208                 }
 209
 210                 public bool IncludeExceptionDetailInFaults {
 211                         get { return include_exception_detail_in_faults; }
 212                         set { include_exception_detail_in_faults = value; }
 213                 }
 214
 215                 public ServiceThrottle ServiceThrottle {
 216                         get { return throttle; }
 217                         set { throttle = value; }
 218                 }
 219
 220                 public IsolationLevel TransactionIsolationLevel {
 221                         get { return tx_isolation_level; }
 222                         set { tx_isolation_level = value; }
 223                 }
 224
 225                 public TimeSpan TransactionTimeout {
 226                         get { return tx_timeout; }
 227                         set { tx_timeout = value; }
 228                 }
 229
 230                 protected internal override void Attach (ServiceHostBase host)
 231                 {
 232                         this.host = host;
 233                 }
 234
 235                 public override void CloseInput ()
 236                 {
 237                         if (loop_manager != null)
 238                                 loop_manager.CloseInput ();
 239                 }
 240
 241                 protected internal override void Detach (ServiceHostBase host)
 242                 {
 243                         this.host = null;
 244                 }
 245
 246                 protected override void OnAbort ()
 247                 {
 248                         if (loop_manager != null)
 249                                 loop_manager.Stop (TimeSpan.FromTicks (1));
 250                 }
 251
 252                 Action<TimeSpan> open_delegate;
 253                 Action<TimeSpan> close_delegate;
 254
 255                 protected override IAsyncResult OnBeginClose (TimeSpan timeout,
 256                         AsyncCallback callback, object state)
 257                 {
 258                         if (close_delegate == null)
 259                                 close_delegate = new Action<TimeSpan> (OnClose);
 260                         return close_delegate.BeginInvoke (timeout, callback, state);
 261                 }
 262
 263                 protected override IAsyncResult OnBeginOpen (TimeSpan timeout,
 264                         AsyncCallback callback, object state)
 265                 {
 266                         if (open_delegate == null)
 267                                 open_delegate = new Action<TimeSpan> (OnClose);
 268                         return open_delegate.BeginInvoke (timeout, callback, state);
 269                 }
 270
 271                 protected override void OnClose (TimeSpan timeout)
 272                 {
 273                         if (loop_manager != null)
 274                                 loop_manager.Stop (timeout);
 275                 }
 276
 277                 protected override void OnClosed ()
 278                 {
 279                         if (host != null)
 280                                 host.ChannelDispatchers.Remove (this);
 281                         base.OnClosed ();
 282                 }
 283
 284                 protected override void OnEndClose (IAsyncResult result)
 285                 {
 286                         close_delegate.EndInvoke (result);
 287                 }
 288
 289                 protected override void OnEndOpen (IAsyncResult result)
 290                 {
 291                         open_delegate.EndInvoke (result);
 292                 }
 293
 294                 protected override void OnOpen (TimeSpan timeout)
 295                 {
 296                         if (Host == null || MessageVersion == null)
 297                                 throw new InvalidOperationException ("Service host is not attached to this ChannelDispatcher.");
 298
 299                         loop_manager = new ListenerLoopManager (this, timeout);
 300                 }
 301
 302                 [MonoTODO ("what to do here?")]
 303                 protected override void OnOpening ()
 304                 {
 305                 }
 306
 307                 protected override void OnOpened ()
 308                 {
 309                         loop_manager.Setup ();
 310                 }
 311
 312                 internal void StartLoop ()
 313                 {
 314                         // FIXME: not sure if it should be filled here.
 315                         if (ServiceThrottle == null)
 316                                 ServiceThrottle = new ServiceThrottle ();
 317
 318                         loop_manager.Start ();
 319                 }
 320         }
 321
 322                 // isolated from ChannelDispatcher
 323                 class ListenerLoopManager
 324                 {
 325                         ChannelDispatcher owner;
 326                         AutoResetEvent throttle_wait_handle = new AutoResetEvent (false);
 327                         AutoResetEvent creator_handle = new AutoResetEvent (false);
 328                         ManualResetEvent stop_handle = new ManualResetEvent (false);
 329                         bool loop;
 330                         Thread loop_thread;
 331                         DateTime close_started;
 332                         TimeSpan open_timeout, close_timeout;
 333                         Func<IAsyncResult> channel_acceptor;
 334                         List<IChannel> channels = new List<IChannel> ();
 335
 336                         public ListenerLoopManager (ChannelDispatcher owner, TimeSpan openTimeout)
 337                         {
 338                                 this.owner = owner;
 339                                 open_timeout = openTimeout;
 340                         }
 341
 342                         public void Setup ()
 343                         {
 344                                 if (owner.Listener.State != CommunicationState.Opened)
 345                                         owner.Listener.Open (open_timeout);
 346
 347                                 // It is tested at Open(), but strangely it is not instantiated at this point.
 348                                 foreach (var ed in owner.Endpoints)
 349                                         if (ed.DispatchRuntime.InstanceContextProvider == null && (ed.DispatchRuntime.Type == null || ed.DispatchRuntime.Type.GetConstructor (Type.EmptyTypes) == null))
 350                                                 throw new InvalidOperationException ("There is no default constructor for the service Type in the DispatchRuntime");
 351                                 SetupChannelAcceptor ();
 352                         }
 353
 354                         public void Start ()
 355                         {
 356                                 foreach (var ed in owner.Endpoints)
 357                                         if (ed.DispatchRuntime.InstanceContextProvider == null)
 358                                                 ed.DispatchRuntime.InstanceContextProvider = new DefaultInstanceContextProvider ();
 359
 360                                 if (loop_thread == null)
 361                                         loop_thread = new Thread (new ThreadStart (Loop));
 362                                 loop_thread.Start ();
 363                         }
 364
 365                         Func<IAsyncResult> CreateAcceptor<TChannel> (IChannelListener l) where TChannel : class, IChannel
 366                         {
 367                                 IChannelListener<TChannel> r = l as IChannelListener<TChannel>;
 368                                 if (r == null)
 369                                         return null;
 370                                 AsyncCallback callback = delegate (IAsyncResult result) {
 371                                         try {
 372                                                 ChannelAccepted (r.EndAcceptChannel (result));
 373                                         } catch (Exception ex) {
 374                                                 Console.WriteLine ("Exception during finishing channel acceptance.");
 375                                                 Console.WriteLine (ex);
 376                                         }
 377                                 };
 378                                 return delegate {
 379                                         try {
 380                                                 return r.BeginAcceptChannel (callback, null);
 381                                         } catch (Exception ex) {
 382                                                 Console.WriteLine ("Exception during accepting channel.");
 383                                                 Console.WriteLine (ex);
 384                                                 throw;
 385                                         }
 386                                 };
 387                         }
 388
 389                         void SetupChannelAcceptor ()
 390                         {
 391                                 var l = owner.Listener;
 392                                 channel_acceptor =
 393                                         CreateAcceptor<IReplyChannel> (l) ??
 394                                         CreateAcceptor<IReplySessionChannel> (l) ??
 395                                         CreateAcceptor<IInputChannel> (l) ??
 396                                         CreateAcceptor<IInputSessionChannel> (l) ??
 397                                         CreateAcceptor<IDuplexChannel> (l) ??
 398                                         CreateAcceptor<IDuplexSessionChannel> (l);
 399                                 if (channel_acceptor == null)
 400                                         throw new InvalidOperationException (String.Format ("Unrecognized channel listener type: {0}", l.GetType ()));
 401                         }
 402
 403                         public void Stop (TimeSpan timeout)
 404                         {
 405                                 if (loop_thread == null)
 406                                         return;
 407
 408                                 close_started = DateTime.Now;
 409                                 close_timeout = timeout;
 410                                 loop = false;
 411                                 creator_handle.Set ();
 412                                 throttle_wait_handle.Set (); // break primary loop
 413                                 if (stop_handle != null) {
 414                                         stop_handle.WaitOne (timeout > TimeSpan.Zero ? timeout : TimeSpan.FromTicks (1));
 415                                         stop_handle.Close ();
 416                                         stop_handle = null;
 417                                 }
 418                                 if (owner.Listener.State != CommunicationState.Closed)
 419                                         owner.Listener.Abort ();
 420                                 if (loop_thread != null && loop_thread.IsAlive)
 421                                         loop_thread.Abort ();
 422                                 loop_thread = null;
 423                         }
 424
 425                         public void CloseInput ()
 426                         {
 427                                 foreach (var ch in channels.ToArray ()) {
 428                                         if (ch.State == CommunicationState.Closed)
 429                                                 channels.Remove (ch); // zonbie, if exists
 430                                         else {
 431                                                 try {
 432                                                         ch.Close (close_timeout - (DateTime.Now - close_started));
 433                                                 } catch (Exception ex) {
 434                                                         // FIXME: log it.
 435                                                         Console.WriteLine (ex);
 436                                                         ch.Abort ();
 437                                                 }
 438                                         }
 439                                 }
 440                         }
 441
 442                         void Loop ()
 443                         {
 444                                 try {
 445                                         LoopCore ();
 446                                 } catch (Exception ex) {
 447                                         // FIXME: log it
 448                                         Console.WriteLine ("ChannelDispatcher caught an exception inside dispatcher loop, which is likely thrown by the channel listener {0}", owner.Listener);
 449                                         Console.WriteLine (ex);
 450                                 } finally {
 451                                         if (stop_handle != null)
 452                                                 stop_handle.Set ();
 453                                 }
 454                         }
 455
 456                         void LoopCore ()
 457                         {
 458                                 loop = true;
 459
 460                                 // FIXME: use WaitForChannel() for (*only* for) transacted channel listeners.
 461                                 // http://social.msdn.microsoft.com/Forums/en-US/wcf/thread/3faa4a5e-8602-4dbe-a181-73b3f581835e
 462
 463                                 //FIXME: The logic here should be somewhat different as follows:
 464                                 //1. Get the message
 465                                 //2. Get the appropriate EndPointDispatcher that can handle the message
 466                                 //   which is done using the filters (AddressFilter, ContractFilter).
 467                                 //3. Let the appropriate endpoint handle the request.
 468
 469                                 while (loop) {
 470                                         while (loop && channels.Count < owner.ServiceThrottle.MaxConcurrentSessions) {
 471                                                 channel_acceptor ();
 472                                                 creator_handle.WaitOne (); // released by ChannelAccepted()
 473                                         }
 474                                         if (!loop)
 475                                                 break;
 476                                         throttle_wait_handle.WaitOne (); // released by IChannel.Close()
 477                                 }
 478                                 try {
 479                                         owner.Listener.Close ();
 480                                 } finally {
 481                                         // make sure to close both listener and channels.
 482                                         owner.CloseInput ();
 483                                 }
 484                         }
 485
 486                         void ChannelAccepted (IChannel ch)
 487                         {
 488                         try {
 489                                 if (ch == null) // could happen when it was aborted
 490                                         return;
 491                                 if (!loop) {
 492                                         var dis = ch as IDisposable;
 493                                         if (dis != null)
 494                                                 dis.Dispose ();
 495                                         return;
 496                                 }
 497
 498                                 channels.Add (ch);
 499                                 ch.Opened += delegate {
 500                                         ch.Faulted += delegate {
 501                                                 if (channels.Contains (ch))
 502                                                         channels.Remove (ch);
 503                                                 throttle_wait_handle.Set (); // release loop wait lock.
 504                                                 };
 505                                         ch.Closed += delegate {
 506                                                 if (channels.Contains (ch))
 507                                                         channels.Remove (ch);
 508                                                 throttle_wait_handle.Set (); // release loop wait lock.
 509                                                 };
 510                                         };
 511                                 ch.Open ();
 512                         } finally {
 513                                 creator_handle.Set ();
 514                         }
 515
 516                                 ProcessRequestOrInput (ch);
 517                         }
 518
 519                         void ProcessRequestOrInput (IChannel ch)
 520                         {
 521                                 var reply = ch as IReplyChannel;
 522                                 var input = ch as IInputChannel;
 523
 524                                 if (reply != null) {
 525                                         if (owner.ReceiveSynchronously) {
 526                                                 RequestContext rc;
 527                                                 if (reply.TryReceiveRequest (owner.timeouts.ReceiveTimeout, out rc))
 528                                                         ProcessRequest (reply, rc);
 529                                         } else {
 530                                                 reply.BeginTryReceiveRequest (owner.timeouts.ReceiveTimeout, TryReceiveRequestDone, reply);
 531                                         }
 532                                 } else if (input != null) {
 533                                         if (owner.ReceiveSynchronously) {
 534                                                 Message msg;
 535                                                 if (input.TryReceive (owner.timeouts.ReceiveTimeout, out msg))
 536                                                         ProcessInput (input, msg);
 537                                         } else {
 538                                                 input.BeginTryReceive (owner.timeouts.ReceiveTimeout, TryReceiveDone, input);
 539                                         }
 540                                 }
 541                         }
 542
 543                         void TryReceiveRequestDone (IAsyncResult result)
 544                         {
 545                                 RequestContext rc;
 546                                 var reply = (IReplyChannel) result.AsyncState;
 547                                 if (reply.EndTryReceiveRequest (result, out rc))
 548                                         ProcessRequest (reply, rc);
 549                         }
 550
 551                         void TryReceiveDone (IAsyncResult result)
 552                         {
 553                                 Message msg;
 554                                 var input = (IInputChannel) result.AsyncState;
 555                                 if (input.EndTryReceive (result, out msg))
 556                                         ProcessInput (input, msg);
 557                         }
 558
 559                         void SendEndpointNotFound (RequestContext rc, EndpointNotFoundException ex)
 560                         {
 561                                 try {
 562
 563                                         MessageVersion version = rc.RequestMessage.Version;
 564                                         FaultCode fc = new FaultCode ("DestinationUnreachable", version.Addressing.Namespace);
 565                                         Message res = Message.CreateMessage (version, fc, "error occured", rc.RequestMessage.Headers.Action);
 566                                         rc.Reply (res);
 567                                 }
 568                                 catch (Exception e) { }
 569                         }
 570
 571                         void ProcessRequest (IReplyChannel reply, RequestContext rc)
 572                         {
 573                                 try {
 574                                         EndpointDispatcher candidate = FindEndpointDispatcher (rc.RequestMessage);
 575                                         new InputOrReplyRequestProcessor (candidate.DispatchRuntime, reply).
 576                                                 ProcessReply (rc);
 577                                 } catch (EndpointNotFoundException ex) {
 578                                         SendEndpointNotFound (rc, ex);
 579                                 } catch (Exception ex) {
 580                                         // FIXME: log it.
 581                                         Console.WriteLine (ex);
 582                                 } finally {
 583                                         if (rc != null)
 584                                                 rc.Close ();
 585                                         // unless it is closed by session/call manager, move it back to the loop to receive the next message.
 586                                         if (reply.State != CommunicationState.Closed)
 587                                                 ProcessRequestOrInput (reply);
 588                                 }
 589                         }
 590
 591                         void ProcessInput (IInputChannel input, Message message)
 592                         {
 593                                 try {
 594                                         EndpointDispatcher candidate = null;
 595                                         candidate = FindEndpointDispatcher (message);
 596                                         new InputOrReplyRequestProcessor (candidate.DispatchRuntime, input).
 597                                                 ProcessInput (message);
 598                                 }
 599                                 catch (Exception ex) {
 600                                         // FIXME: log it.
 601                                         Console.WriteLine (ex);
 602                                 } finally {
 603                                         // unless it is closed by session/call manager, move it back to the loop to receive the next message.
 604                                         if (input.State != CommunicationState.Closed)
 605                                                 ProcessRequestOrInput (input);
 606                                 }
 607                         }
 608
 609                         EndpointDispatcher FindEndpointDispatcher (Message message) {
 610                                 EndpointDispatcher candidate = null;
 611                                 for (int i = 0; i < owner.Endpoints.Count; i++) {
 612                                         if (MessageMatchesEndpointDispatcher (message, owner.Endpoints [i])) {
 613                                                 var newdis = owner.Endpoints [i];
 614                                                 if (candidate == null || candidate.FilterPriority < newdis.FilterPriority)
 615                                                         candidate = newdis;
 616                                                 else if (candidate.FilterPriority == newdis.FilterPriority)
 617                                                         throw new MultipleFilterMatchesException ();
 618                                         }
 619                                 }
 620                                 if (candidate == null && owner.Host != null)
 621                                         owner.Host.OnUnknownMessageReceived (message);
 622                                 return candidate;
 623                         }
 624
 625                         bool MessageMatchesEndpointDispatcher (Message req, EndpointDispatcher endpoint)
 626                         {
 627                                 Uri to = req.Headers.To;
 628                                 if (to == null)
 629                                         return false;
 630                                 if (to.AbsoluteUri == Constants.WsaAnonymousUri)
 631                                         return false;
 632                                 return endpoint.AddressFilter.Match (req) && endpoint.ContractFilter.Match (req);
 633                         }
 634                 }
 635 }