summaryrefslogtreecommitdiff
path: root/IvyPPC/IvyClient.cs
blob: 3db9f0f54ae7d23c32e6a36d31fed2b91e7fa28b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
/// François-Régis Colin
/// http://www.tls.cena.fr/products/ivy/
/// *
/// (C) CENA
/// *
namespace IvyBus
{
	using System;
	using System.Collections;
    using System.Collections.Specialized;
    using System.Collections.Generic;
	using System.Threading;
	using System.Text;
	using System.IO;
	using System.Net;
	using System.Net.Sockets;
	using System.Configuration;
    using System.Diagnostics;

	/// <summary> A Class for the the peers on the bus.
	/// </summary>
	/// <remarks>
	/// each time a connexion is made with a remote peer, the regexp are exchanged
	/// once ready, a ready message is sent, and then we can send messages, 
	/// die messages, direct messages, add or remove regexps, or quit. A thread is
	/// created for each remote client.
	/// </remarks>
    public class IvyClient : IvyProtocol, IComparable<IvyClient>, IDisposable  
	{
        public int CompareTo(IvyClient other)
        {
            return (other.clientPriority - clientPriority);
        }

		public String ApplicationName
		{
			get
			{
				return appName;
			}
			
		}

        public List<string> Regexps
		{
			get
			{
                List<string> tab = new List<string>();
                lock (bindings)
                {
                    foreach (IvyBindingBase bind in bindings.Values)
                        tab.Add(bind.Expression);
                }
				return tab;
			}
			
		}
		internal int AppPort
		{
			get
			{
				return appPort;
			}
			
		}
        public IPAddress RemoteAddress
		{
			get
			{
                return remoteHost;
			}
			
		}
		public int RemotePort
		{
			get
			{
                return remotePort;
			}
			
		}
		
		private Ivy bus;
        private Dictionary<ushort,IvyBindingBase> bindings;
		private int appPort;
		private string clientId;	/* an unique ID for each IvyClient */
		private int clientPriority;	/* client priority */
		
		private volatile Thread clientThread; // volatile to ensure the quick communication
        private bool doping; // false by runtime default
		private const int PINGTIMEOUT = 5000;
		private volatile Thread pingerThread;

        private int remotePort;
        private IPAddress remoteHost;
		
		// protected variables
		internal String appName;
        internal IvyProtocol stream;

		internal IvyClient(Ivy bus, Socket socket, string appname)
		{
			bindings = new Dictionary<ushort,IvyBindingBase>();
			appName = appname;
			this.bus = bus;
            
            IPEndPoint endpoint = (IPEndPoint)socket.RemoteEndPoint;

            remoteHost = endpoint.Address;
            remotePort = endpoint.Port;
                
#if (!PocketPC )
            socket.SetSocketOption( SocketOptionLevel.Tcp, SocketOptionName.KeepAlive, 1 );
#endif

            if ( bus.ProtocolVersion == 4 )
    			stream = new IvyTCPStreamV4( socket, this );
                else
                stream = new IvyTCPStreamV3(socket, this);

			clientPriority = Ivy.DEFAULT_PRIORITY;
            // spawns a thread to manage the incoming traffic on this
            // socket. We should be ready to receive messages now.
            clientThread = new Thread(new ThreadStart(this.Run));
            clientThread.Name = "Ivy Tcp Client Reader Thread ("+appname+")";
            clientThread.Start();

		}

        internal void SendBindings()
        {
            try
            {
                stream.TokenApplicationId(bus.applicationPriority, bus.AppId);

                // sends our ID, whether we initiated the connexion or not
                // the ID is the couple "host name,application Port", the host name
                // information is in the socket itself, the port is not known if we
                // initiate the connexion
                stream.TokenStartRegexp(bus.applicationPort, bus.appName);
                // sends our regexps to the peer
                lock (bus.bindings)
                {
                    foreach (IvyApplicationBinding bind in bus.bindings.Values)
                    {
                        stream.TokenAddBinding(bind.Binding, bind.Key, bind.FormatedExpression);
                    }
                }
                stream.TokenEndRegexp();
              
#if (!PocketPC)
                doping = Properties.Settings.Default.IvyPing;
#endif
                if (doping)
                {
                    pingerThread = new Thread(new ThreadStart(PingerRun));
                    pingerThread.Name = "Ivy Pinger Thread";
                    pingerThread.Start();
                }


            }
            catch (IOException ex)
            { // the client nous a coupé l'herbe sous le pied 
                Ivy.traceError("IvyClient","I can't send my message to this client. He probably left " + ex.Message);
                // invokes the Disconnected applicationListeners
                //bus.OnClientDisconnected(new IvyEventArgs(this,id, message ));
                // called by the receiver Thread
                close(false);
            }
        }
		
		/// <summary>  returns the name of the remote agent.
		/// allow an Ivy package class to access the list of regexps at a
		/// given time.
		/// perhaps we should implement a new IvyApplicationListener method to
		/// allow the notification of regexp addition and deletion
		/// </summary>
		
		/// <summary> sends a direct message to the peer
		/// </summary>
		/// <param name='id'>the numeric value provided to the remote client
		/// </param>
		/// <param name='message'>the string that will be match-tested
		/// 
		/// </param>
        public void SendDirectMsg(ushort id, string message)
		{
			try 
			{
                stream.TokenDirectMsg( id, message);
			}
			catch (IOException ex)
			{
				Ivy.traceError("IvyClient","I can't send my message to this client. He probably left "+ex.Message);
				// first, I'm not a first class IvyClient any more
				bus.removeClient(this);
				// invokes the Disconnected applicationListeners
                //bus.OnClientDisconnected(new IvyEventArgs(this,id, message ));
                // should be called by receiver thread
				close(false);
			}
		}
		
		/// <summary> closes the connexion to the peer.
		/// </summary>
		/// <param name='notify'>should I send Bye message ?
		/// the thread managing the socket is stopped
		/// 
		/// </param>
		internal void  close(bool notify)
		{
			Ivy.traceProtocol("IvyClient","closing connexion to " + appName);
			if (doping )
			{
				StopPinging();
			}
			if (notify)
                try
                {
                    stream.TokenBye(0, "hasta la vista");
                }
                catch (IOException ioe)
                {
                    throw new IvyException(ioe.Message);
                }
            // stop the thread and close the stream
            if (clientThread == null)
                return;
            // Tell Thread to stop.
            if (stream != null)
            {
                try
                {
                    stream.Close();    // should stop the Reading Client Thread 
                }
                catch (IOException ioe)
                {
                    throw new IvyException(ioe.Message);
                }
                //socket.Close(); // pris en charge par stream ( NetWorkStream )
                stream = null;
            }
            // Potential dead lok when thread issue ClientDisconnected event
            //if (Thread.CurrentThread != clientThread && (clientThread != null))
            //{
            //    // Wait for Thread to end.
            //    bool term = clientThread.Join(10000);
            //    if (!term && (clientThread != null)) clientThread.Abort();
            //}

            clientThread = null;
            
		
		}
		
		/// <summary> sends the substrings of a message to the peer for each matching regexp.
		/// </summary>
		/// <param name='message'>the string that will be match-tested
		/// </param>
		/// <returns>the number of messages sent to the peer
		/// 
		/// </returns>
		internal int sendMsg(String message)
		{
			int count = 0;
                    
			lock( bindings )
            {
                try
                {
                    foreach (IvyBindingBase bind in bindings.Values)
                    {
                        string[] args = bind.Match(message);
                        if (stream != null && args != null)
                        {
                            stream.TokenMsg(bind.Key, args);
                            count++;
                        }
                    }
                }
                catch (IOException ex)
                {
                    Ivy.traceError("IvyClient","I can't send my message to this client. He probably left " + ex.Message);
                    // first, I'm not a first class IvyClient any more
                    bus.removeClient(this);
                    // invokes the Disconnected applicationListeners
                    // in the receiver thread
                    close(false);
                }
			
               
			}
			return count;
		}
		
		/// <summary> compares two peers the id is the couple (host,service port).
		/// </summary>
		/// <param name='clnt'>the other peer
		/// </param>
		/// <returns>true if the peers are similir. This should not happen, it is bad
		/// © ® (tm)
		/// 
		/// </returns>
		internal bool sameClient(IvyClient clnt)
		{
			return (appPort != 0 && appPort == clnt.appPort) && (RemoteAddress == clnt.RemoteAddress);
		}
		
		/// <summary> the code of the thread handling the incoming messages.
		/// </summary>
		private void  Run()
		{
			Ivy.traceProtocol("IvyClient","Connected from " + RemoteAddress + ":" + RemotePort);
			
			Ivy.traceProtocol("IvyClient","Thread started");
			
			bool running = true;
			while ( running && (stream != null) )
			{
				try
				{
					if ( stream.receiveMsg() )
					{
						// early stop during readLine()
						if (doping && (pingerThread != null))
							pingerThread.Abort();
					}
					else
					{
						Ivy.traceProtocol("IvyClient","receiveMsg false ! leaving the thread");
                        running = false;
						break;
					}
				}
				catch ( ObjectDisposedException ex )
				{
					Ivy.traceError("IvyClient", "socket closed "+ex.Message );
					running = false;
					break;
				}
				catch (IvyException ie)
				{
                    Ivy.traceError("IvyClient","socket closed IvyException" + ie.Message);
                    running = false;
					break;
				}
				catch (SocketException se)
				{
					Ivy.traceError("IvyClient", "socket closed "+se.Message );
					running = false;
					break;
				}
				catch (IOException ex)
				{
					if ( ex.InnerException is SocketException )
					{
						Ivy.traceProtocol("IvyClient", "socket closed" );
					
					}
					else 
					{
						Ivy.traceError("IvyClient","abnormally Disconnected from " + RemoteAddress + ":" + RemotePort);
					}
					running = false;
					break;
				}
			}
			Ivy.traceProtocol("IvyClient","normally Disconnected from " + appName);
			Ivy.traceProtocol("IvyClient","Thread stopped");
			// invokes the Disconnected applicationListeners
            bus.OnClientDisconnected(new IvyEventArgs(this,0, "" ));
			// first, I'm not a first class IvyClient any more
            if (stream != null)
            {
                stream.Close();
                stream = null;
            }
			bus.removeClient(this);
			
		}
        void IvyProtocol.Close()
        {
            // never call in this side
        }
        bool IvyProtocol.receiveMsg()
        {
            // nerver call in this side
            return false;
        }
        void IvyProtocol.TokenDie(ushort id, string arg)
		{
			Ivy.traceProtocol("IvyClient","received die Message from " + appName + "Raison: "+ arg);
			// invokes the die applicationListeners
            IvyDieEventArgs ev = new IvyDieEventArgs(this, id, arg);
            bus.OnDie(ev);
            // first, I'm not a first class IvyClient any more
            bus.removeClient(this);
            // makes the bus die
			bus.Stop();
			close(false);
            if (ev.ForceExit)
#if (PocketPC)
                System.Windows.Forms.Application.Exit();
#else
				System.Environment.Exit(0);
#endif
		}
        void IvyProtocol.TokenBye(ushort err, string arg)
		{
			// the peer quits
			Ivy.traceProtocol("IvyClient","received bye Message from " + appName + "Raison: "+ arg);
			// first, I'm not a first class IvyClient any more
			//bus.removeClient(this); // this is done in the receive thread terminaison!!
			// invokes the disconnect applicationListeners
			//bus.FireClientDisconnected(this); done in Running Thread
			close(false);  // will fire disconnected
		}

        void IvyProtocol.TokenAddBinding(BindingType type, ushort id, string expression)
		{
			
            if (type == BindingType.Regexp && !bus.CheckRegexp(expression))
            {
            bus.OnClientFilterBinding(new IvyEventArgs(this, id, expression ));
            return;
            }
            IvyBindingBase bind = null;
            try
            {
                switch (type)
                {
                    case BindingType.Regexp:
                        bind = new IvyBindingRegexp(id, expression);
                        break;
                    case BindingType.Simple:
                        bind = new IvyBindingSimple(id, expression);
                        break;
                }
                lock (bindings)
                {
                    bindings.Add(id, bind);
                }

                bus.OnClientAddBinding(new IvyEventArgs(this, id, expression));
                
			}
			catch (ArgumentException ex)
			{
				throw new IvyException("binding expression error " + ex.Message);
			}
					
		}
        void IvyProtocol.TokenDelBinding(ushort id)
		{
			lock( bindings )
			{
                try
                {
                    IvyBindingBase bind = bindings[id];
                    bus.OnClientRemoveBinding(new IvyEventArgs(this, bind.Key, bind.Expression));
                    bindings.Remove(id);
                }
                catch (KeyNotFoundException ex)
                {
                    Ivy.traceError("IvyClient","DelBinding " + ex.Message);
                }
			}
		}
        void IvyProtocol.TokenMsg(ushort id, string[] args)
		{
            bus.OnMessage(new IvyMessageEventArgs(this, id, args));		
		}
        void IvyProtocol.TokenError(ushort id, string arg)
		{
            bus.OnError(new IvyEventArgs(this, id, arg));
			Ivy.traceError("IvyClient","Error msg " + id + " " + arg);
		}
        void IvyProtocol.TokenApplicationId(ushort id, string arg)
		{
			clientId = arg;
			if ( clientPriority != id )
			{
				clientPriority = id;
				bus.SortClients();
			}
		}
        void IvyProtocol.TokenEndRegexp()
		{
            /* 
            * the peer is perhaps not ready to handle this message
            * an assymetric processing should be written
            */
            if (bus.ReadyMessage != null)
                sendMsg(bus.ReadyMessage);
            bus.OnClientConnected(new IvyEventArgs(this, 0, ""));
		}
        void IvyProtocol.TokenStartRegexp(ushort id, string arg)
		{
			appName = arg;
			appPort = id;
			if (bus.checkConnected(this))
			{
				close(false);
				throw new IvyException("Rare ! A concurrent connect occured");
			}
					
		}
        void IvyProtocol.TokenDirectMsg(ushort id, string arg)
		{
            bus.OnDirectMessage(new IvyEventArgs(this,id,arg));
		}
        void IvyProtocol.TokenPing(string arg)
		{
			// I receive a ping. I can answer a pong.
			Ivy.traceProtocol("IvyClient","Ping msg from " + appName + " : " +  arg );
			stream.TokenPong(arg);
		}
        void IvyProtocol.TokenPong(string arg)
		{
			Ivy.traceProtocol("IvyClient","Ping msg from " + appName + " : " + arg);
		}
		
		
		
		public override String ToString()
		{
			return "IvyClient " + bus.appName + ":" + appName;
		}

		/* is the Pinging Thread Runninng */
		internal bool isPinging;

		private void  PingerRun()
		{
			isPinging = true;
			Ivy.traceProtocol("IvyClient","Pinger Thread started");
			while (isPinging)
			{
				try
				{
					Thread.Sleep(PINGTIMEOUT);
					stream.TokenPing("are you here ?");
				}
				catch (ThreadAbortException ie)
				{
                    Ivy.traceError("IvyClient","Pinger Thread killed "+ie.Message);
				}
			}
			Ivy.traceProtocol("IvyClient","Pinger Thread stopped");
		}
		public virtual void  StopPinging()
		{
			isPinging = false; 
			//pingerThread.Interrupt();
            pingerThread.Abort();
		}

        #region IDisposable Members

         //Implement IDisposable.
        public void Dispose()
        {
            Dispose(true);
            GC.SuppressFinalize(this);
        }

        protected virtual void Dispose(bool disposing)
        {
            if (disposing)
            {
                // Free other state (managed objects).
            }
            // Free your own state (unmanaged objects).
            // Set large fields to null.
            if (stream != null)
            {
                stream.Close();
                stream = null;
            }
        }

        // Use C# destructor syntax for finalization code.
        ~IvyClient()
        {
            // Simply call Dispose(false).
            Dispose(false);
        }

        #endregion
    }
}