2 // ChannelDispatcher.cs
5 // Atsushi Enomoto <atsushi@ximian.com>
7 // Copyright (C) 2005,2009 Novell, Inc. http://www.novell.com
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:
17 // The above copyright notice and this permission notice shall be
18 // included in all copies or substantial portions of the Software.
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.
29 using System.Collections.Generic;
30 using System.Collections.ObjectModel;
32 using System.Reflection;
33 using System.ServiceModel.Channels;
34 using System.Threading;
35 using System.Transactions;
36 using System.ServiceModel;
37 using System.ServiceModel.Description;
38 using System.Net.Sockets;
42 namespace System.ServiceModel.Dispatcher
44 public class ChannelDispatcher : ChannelDispatcherBase
46 class EndpointDispatcherCollection : SynchronizedCollection<EndpointDispatcher>
48 public EndpointDispatcherCollection (ChannelDispatcher owner)
53 ChannelDispatcher owner;
55 protected override void ClearItems ()
57 foreach (var ed in this)
58 ed.ChannelDispatcher = null;
62 protected override void InsertItem (int index, EndpointDispatcher item)
64 item.ChannelDispatcher = owner;
65 base.InsertItem (index, item);
68 protected override void RemoveItem (int index)
71 this [index].ChannelDispatcher = null;
72 base.RemoveItem (index);
75 protected override void SetItem (int index, EndpointDispatcher item)
77 item.ChannelDispatcher = owner;
78 base.SetItem (index, item);
85 Collection<IErrorHandler> error_handlers
86 = new Collection<IErrorHandler> ();
87 IChannelListener listener;
88 internal IDefaultCommunicationTimeouts timeouts; // FIXME: remove internal
89 MessageVersion message_version;
90 bool receive_sync, include_exception_detail_in_faults,
91 manual_addressing, is_tx_receive;
92 int max_tx_batch_size;
93 SynchronizedCollection<IChannelInitializer> initializers
94 = new SynchronizedCollection<IChannelInitializer> ();
95 IsolationLevel tx_isolation_level;
97 ServiceThrottle throttle;
99 Guid identifier = Guid.NewGuid ();
100 ManualResetEvent async_event = new ManualResetEvent (false);
102 ListenerLoopManager loop_manager;
103 SynchronizedCollection<EndpointDispatcher> endpoints;
105 [MonoTODO ("get binding info from config")]
106 public ChannelDispatcher (IChannelListener listener)
107 : this (listener, null)
111 public ChannelDispatcher (
112 IChannelListener listener, string bindingName)
113 : this (listener, bindingName, null)
117 public ChannelDispatcher (
118 IChannelListener listener, string bindingName,
119 IDefaultCommunicationTimeouts timeouts)
121 if (listener == null)
122 throw new ArgumentNullException ("listener");
123 Init (listener, bindingName, timeouts);
126 private void Init (IChannelListener listener, string bindingName,
127 IDefaultCommunicationTimeouts timeouts)
129 this.listener = listener;
130 this.binding_name = bindingName;
131 // IChannelListener is often a ChannelListenerBase
132 // which implements IDefaultCommunicationTimeouts.
133 this.timeouts = timeouts ?? listener as IDefaultCommunicationTimeouts ?? DefaultCommunicationTimeouts.Instance;
134 endpoints = new EndpointDispatcherCollection (this);
137 internal EndpointDispatcher InitializeServiceEndpoint (Type serviceType, ServiceEndpoint se)
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);
146 public string BindingName {
147 get { return binding_name; }
150 public SynchronizedCollection<IChannelInitializer> ChannelInitializers {
151 get { return initializers; }
154 protected internal override TimeSpan DefaultCloseTimeout {
155 get { return timeouts.CloseTimeout; }
158 protected internal override TimeSpan DefaultOpenTimeout {
159 get { return timeouts.OpenTimeout; }
162 public Collection<IErrorHandler> ErrorHandlers {
163 get { return error_handlers; }
166 public SynchronizedCollection<EndpointDispatcher> Endpoints {
167 get { return endpoints; }
171 public bool IsTransactedAccept {
172 get { throw new NotImplementedException (); }
175 public bool IsTransactedReceive {
176 get { return is_tx_receive; }
177 set { is_tx_receive = value; }
180 public bool ManualAddressing {
181 get { return manual_addressing; }
182 set { manual_addressing = value; }
185 public int MaxTransactedBatchSize {
186 get { return max_tx_batch_size; }
187 set { max_tx_batch_size = value; }
190 public override ServiceHostBase Host {
194 public override IChannelListener Listener {
195 get { return listener; }
198 public MessageVersion MessageVersion {
199 get { return message_version; }
200 set { message_version = value; }
203 public bool ReceiveSynchronously {
204 get { return receive_sync; }
206 ThrowIfDisposedOrImmutable ();
207 receive_sync = value;
211 public bool IncludeExceptionDetailInFaults {
212 get { return include_exception_detail_in_faults; }
213 set { include_exception_detail_in_faults = value; }
216 public ServiceThrottle ServiceThrottle {
217 get { return throttle; }
218 set { throttle = value; }
221 public IsolationLevel TransactionIsolationLevel {
222 get { return tx_isolation_level; }
223 set { tx_isolation_level = value; }
226 public TimeSpan TransactionTimeout {
227 get { return tx_timeout; }
228 set { tx_timeout = value; }
231 protected internal override void Attach (ServiceHostBase host)
234 var bl = listener as IChannelDispatcherBoundListener;
236 bl.ChannelDispatcher = this;
239 public override void CloseInput ()
241 if (loop_manager != null)
242 loop_manager.CloseInput ();
245 protected internal override void Detach (ServiceHostBase host)
250 protected override void OnAbort ()
252 if (loop_manager != null)
253 loop_manager.Stop (TimeSpan.FromTicks (1));
256 Action<TimeSpan> open_delegate;
257 Action<TimeSpan> close_delegate;
259 protected override IAsyncResult OnBeginClose (TimeSpan timeout,
260 AsyncCallback callback, object state)
262 if (close_delegate == null)
263 close_delegate = new Action<TimeSpan> (OnClose);
264 return close_delegate.BeginInvoke (timeout, callback, state);
267 protected override IAsyncResult OnBeginOpen (TimeSpan timeout,
268 AsyncCallback callback, object state)
270 if (open_delegate == null)
271 open_delegate = new Action<TimeSpan> (OnOpen);
272 return open_delegate.BeginInvoke (timeout, callback, state);
275 protected override void OnClose (TimeSpan timeout)
277 if (loop_manager != null)
278 loop_manager.Stop (timeout);
281 protected override void OnClosed ()
284 host.ChannelDispatchers.Remove (this);
288 protected override void OnEndClose (IAsyncResult result)
290 close_delegate.EndInvoke (result);
293 protected override void OnEndOpen (IAsyncResult result)
295 open_delegate.EndInvoke (result);
298 protected override void OnOpen (TimeSpan timeout)
300 if (Host == null || MessageVersion == null)
301 throw new InvalidOperationException ("Service host is not attached to this ChannelDispatcher.");
303 loop_manager.Setup (timeout);
306 protected override void OnOpening ()
309 loop_manager = new ListenerLoopManager (this);
312 protected override void OnOpened ()
320 // FIXME: not sure if it should be filled here.
321 if (ServiceThrottle == null)
322 ServiceThrottle = new ServiceThrottle (this);
324 loop_manager.Start ();
328 // isolated from ChannelDispatcher
329 class ListenerLoopManager
331 ChannelDispatcher owner;
332 AutoResetEvent throttle_wait_handle = new AutoResetEvent (false);
333 AutoResetEvent creator_handle = new AutoResetEvent (false);
334 ManualResetEvent stop_handle = new ManualResetEvent (false);
337 DateTime close_started;
338 TimeSpan close_timeout;
339 Func<IAsyncResult> channel_acceptor;
340 List<IChannel> channels = new List<IChannel> ();
341 AddressFilterMode address_filter_mode;
342 List<ISession> sessions = new List<ISession> ();
344 public ListenerLoopManager (ChannelDispatcher owner)
347 var sba = owner.Host != null ? owner.Host.Description.Behaviors.Find<ServiceBehaviorAttribute> () : null;
349 address_filter_mode = sba.AddressFilterMode;
352 public void Setup (TimeSpan openTimeout)
354 if (owner.Listener.State != CommunicationState.Created)
355 throw new InvalidOperationException ("Tried to open the channel listener which is bound to ChannelDispatcher, but it is not at Created state");
356 owner.Listener.Open (openTimeout);
358 // It is tested at Open(), but strangely it is not instantiated at this point.
359 foreach (var ed in owner.Endpoints)
360 if (ed.DispatchRuntime.InstanceContextProvider == null && (ed.DispatchRuntime.Type == null || ed.DispatchRuntime.Type.GetConstructor (Type.EmptyTypes) == null))
361 throw new InvalidOperationException ("There is no default constructor for the service Type in the DispatchRuntime");
362 SetupChannelAcceptor ();
367 if (loop_thread == null)
368 loop_thread = new Thread (new ThreadStart (Loop));
369 loop_thread.Start ();
372 Func<IAsyncResult> CreateAcceptor<TChannel> (IChannelListener l) where TChannel : class, IChannel
374 IChannelListener<TChannel> r = l as IChannelListener<TChannel>;
377 AsyncCallback callback = delegate (IAsyncResult result) {
379 ChannelAccepted (r.EndAcceptChannel (result));
380 } catch (Exception ex) {
381 Logger.Error ("Exception during finishing channel acceptance.", ex);
382 creator_handle.Set ();
387 return r.BeginAcceptChannel (callback, null);
388 } catch (Exception ex) {
389 Logger.Error ("Exception during accepting channel.", ex);
395 void SetupChannelAcceptor ()
397 var l = owner.Listener;
399 CreateAcceptor<IReplyChannel> (l) ??
400 CreateAcceptor<IReplySessionChannel> (l) ??
401 CreateAcceptor<IInputChannel> (l) ??
402 CreateAcceptor<IInputSessionChannel> (l) ??
403 CreateAcceptor<IDuplexChannel> (l) ??
404 CreateAcceptor<IDuplexSessionChannel> (l);
405 if (channel_acceptor == null)
406 throw new InvalidOperationException (String.Format ("Unrecognized channel listener type: {0}", l.GetType ()));
409 public void Stop (TimeSpan timeout)
411 if (loop_thread == null)
414 close_started = DateTime.Now;
415 close_timeout = timeout;
417 creator_handle.Set ();
418 throttle_wait_handle.Set (); // break primary loop
419 if (stop_handle != null) {
420 stop_handle.WaitOne (timeout > TimeSpan.Zero ? timeout : TimeSpan.FromTicks (1));
421 stop_handle.Close ();
424 if (owner.Listener.State != CommunicationState.Closed) {
425 Logger.Warning (String.Format ("Channel listener '{0}' is not closed. Aborting.", owner.Listener.GetType ()));
426 owner.Listener.Abort ();
428 if (loop_thread != null && loop_thread.IsAlive)
429 loop_thread.Abort ();
433 void AddChannel (IChannel ch)
436 var ich = ch as ISessionChannel<IInputSession>;
437 if (ich != null && ich.Session != null) {
439 var session = sessions.FirstOrDefault (s => s.Id == ich.Session.Id);
441 sessions.Add (session);
446 void RemoveChannel (IChannel ch)
448 channels.Remove (ch); // zonbie, if exists
449 var ich = ch as ISessionChannel<IInputSession>;
451 if (ich != null && ich.Session != null)
452 sessions.Remove (ich.Session);
455 public void CloseInput ()
457 foreach (var ch in channels.ToArray ()) {
458 if (ch.State == CommunicationState.Closed)
462 ch.Close (close_timeout - (DateTime.Now - close_started));
463 } catch (Exception ex) {
465 Logger.Error (String.Format ("Exception on closing channel ({0})", ch.GetType ()), ex);
476 } catch (Exception ex) {
477 Logger.Error (String.Format ("ListenerLoopManager caught an exception inside dispatcher loop, which is likely thrown by the channel listener {0}", owner.Listener), ex);
479 if (stop_handle != null)
488 // FIXME: use WaitForChannel() for (*only* for) transacted channel listeners.
489 // http://social.msdn.microsoft.com/Forums/en-US/wcf/thread/3faa4a5e-8602-4dbe-a181-73b3f581835e
492 // FIXME: take MaxConcurrentCalls into consideration appropriately.
493 while (loop && channels.Count < Math.Min (owner.ServiceThrottle.MaxConcurrentSessions, owner.ServiceThrottle.MaxConcurrentCalls)) {
494 // FIXME: this should not be required, but saves multi-ChannelDispatcher case (Throttling enabled) for HTTP standalone listener...
497 creator_handle.WaitOne (); // released by ChannelAccepted()
501 throttle_wait_handle.WaitOne (); // released by IChannel.Close()
504 owner.Listener.Close ();
505 } catch (Exception ex) {
506 Logger.Error (String.Format ("Exception while closing IChannelListener ({0})", owner.Listener.GetType ()), ex);
508 // make sure to close both listener and channels.
513 void ChannelAccepted (IChannel ch)
516 if (ch == null) // could happen when it was aborted
519 var dis = ch as IDisposable;
527 ch.Opened += delegate {
528 ch.Faulted += delegate {
530 if (channels.Contains (ch))
532 throttle_wait_handle.Set (); // release loop wait lock.
534 ch.Closed += delegate {
536 if (channels.Contains (ch))
538 throttle_wait_handle.Set (); // release loop wait lock.
543 creator_handle.Set ();
546 ProcessRequestOrInput (ch);
549 void ProcessRequestOrInput (IChannel ch)
551 var reply = ch as IReplyChannel;
552 var input = ch as IInputChannel;
555 if (owner.ReceiveSynchronously) {
557 if (reply.TryReceiveRequest (owner.timeouts.ReceiveTimeout, out rc))
558 ProcessRequest (reply, rc);
560 reply.BeginTryReceiveRequest (owner.timeouts.ReceiveTimeout, TryReceiveRequestDone, reply);
562 } else if (input != null) {
563 if (owner.ReceiveSynchronously) {
565 if (input.TryReceive (owner.timeouts.ReceiveTimeout, out msg))
566 ProcessInput (input, msg);
568 input.BeginTryReceive (owner.timeouts.ReceiveTimeout, TryReceiveDone, input);
573 void TryReceiveRequestDone (IAsyncResult result)
576 var reply = (IReplyChannel) result.AsyncState;
577 if (reply.EndTryReceiveRequest (result, out rc))
578 ProcessRequest (reply, rc);
583 void TryReceiveDone (IAsyncResult result)
586 var input = (IInputChannel) result.AsyncState;
587 if (input.EndTryReceive (result, out msg))
588 ProcessInput (input, msg);
593 void ProcessRequest (IReplyChannel reply, RequestContext rc)
596 var req = rc.RequestMessage;
597 var ed = FindEndpointDispatcher (req);
598 new InputOrReplyRequestProcessor (ed.DispatchRuntime, reply).ProcessReply (rc);
599 } catch (Exception ex) {
601 if (ProcessErrorWithHandlers (reply, ex, out res))
604 if ((!(ex is SocketException)) &&
605 (!(ex is XmlException)) &&
606 (!(ex is IOException)))
609 reply.Close (owner.DefaultCloseTimeout); // close the channel
613 // unless it is closed by session/call manager, move it back to the loop to receive the next message.
614 if (loop && reply.State != CommunicationState.Closed)
615 ProcessRequestOrInput (reply);
619 bool ProcessErrorWithHandlers (IChannel ch, Exception ex, out Message res)
623 foreach (var eh in owner.ErrorHandlers)
624 if (eh.HandleError (ex))
625 return true; // error is handled appropriately.
627 Logger.Error ("An error occured, to be handled", ex);
629 foreach (var eh in owner.ErrorHandlers)
630 eh.ProvideFault (ex, owner.MessageVersion, ref res);
632 var conv = ch.GetProperty<FaultConverter> () ?? FaultConverter.GetDefaultFaultConverter (owner.MessageVersion);
633 if (!conv.TryCreateFaultMessage (ex, out res))
634 res = Message.CreateMessage (owner.MessageVersion, new FaultCode ("Receiver"), ex.Message, owner.MessageVersion.Addressing.FaultNamespace);
640 void ProcessInput (IInputChannel input, Message message)
643 EndpointDispatcher candidate = null;
644 candidate = FindEndpointDispatcher (message);
645 new InputOrReplyRequestProcessor (candidate.DispatchRuntime, input).ProcessInput (message);
647 catch (Exception ex) {
649 ProcessErrorWithHandlers (input, ex, out dummy);
651 // unless it is closed by session/call manager, move it back to the loop to receive the next message.
652 if (loop && input.State != CommunicationState.Closed)
653 ProcessRequestOrInput (input);
657 EndpointDispatcher FindEndpointDispatcher (Message message) {
658 EndpointDispatcher candidate = null;
659 bool hasEndpointMatch = false;
660 foreach (var endpoint in owner.Endpoints) {
661 if (endpoint.AddressFilter.Match (message)) {
662 hasEndpointMatch = true;
663 if (!endpoint.ContractFilter.Match (message))
665 var newdis = endpoint;
666 if (candidate == null || candidate.FilterPriority < newdis.FilterPriority)
668 else if (candidate.FilterPriority == newdis.FilterPriority)
669 throw new MultipleFilterMatchesException ();
672 if (candidate == null && !hasEndpointMatch) {
673 if (owner.Host != null)
674 owner.Host.OnUnknownMessageReceived (message);
675 // we have to return a fault to the client anyways...
676 throw new EndpointNotFoundException ();
678 else if (candidate == null)
679 // FIXME: It is not a good place to check, but anyways detach this error from EndpointNotFoundException.
680 throw new ActionNotSupportedException (String.Format ("Action '{0}' did not match any operations in the target contract", message.Headers.Action));