diff options
Diffstat (limited to 'CSharp/Ivy/IvyPPC')
| -rw-r--r-- | CSharp/Ivy/IvyPPC/IvyClient.cs | 41 |
1 files changed, 19 insertions, 22 deletions
diff --git a/CSharp/Ivy/IvyPPC/IvyClient.cs b/CSharp/Ivy/IvyPPC/IvyClient.cs index 2244b17..9ccac6e 100644 --- a/CSharp/Ivy/IvyPPC/IvyClient.cs +++ b/CSharp/Ivy/IvyPPC/IvyClient.cs @@ -1,17 +1,8 @@ -/// <summary> A private Class for the the peers on the bus.
+/// François-Régis Colin
+/// http://www.tls.cena.fr/products/ivy/
/// *
-/// </summary>
-/// <author> François-Régis Colin
-/// </author>
-/// <author> <a href="http://www.tls.cena.fr/products/ivy/">http://www.tls.cena.fr/products/ivy/</a>
+/// (C) CENA
/// *
-/// 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.
-/// *
-///
-/// </author>
namespace IvyBus
{
using System;
@@ -24,6 +15,8 @@ namespace IvyBus using System.Net.Sockets;
using System.Configuration;
+ /// <summary> A private Class for the the peers on the bus.
+ /// </summary>
internal class MyTcpClient : TcpClient
{
public IPAddress RemoteAddress
@@ -52,7 +45,14 @@ namespace IvyBus Client = sock;
}
}
-
+ /// <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
{
public String ApplicationName
@@ -177,10 +177,7 @@ namespace IvyBus }
/// <summary> returns the name of the remote agent.
- /// </summary>
-
-
- /// <summary> allow an Ivy package class to access the list of regexps at a
+ /// 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
@@ -199,9 +196,9 @@ namespace IvyBus /// <summary> sends a direct message to the peer
/// </summary>
- /// <param name="id">the numeric value provided to the remote client
+ /// <param name='id'>the numeric value provided to the remote client
/// </param>
- /// <param name="message">the string that will be match-tested
+ /// <param name='message'>the string that will be match-tested
///
/// </param>
public void sendDirectMsg(int id, String message)
@@ -211,7 +208,7 @@ namespace IvyBus /// <summary> closes the connexion to the peer.
/// </summary>
- /// <param name="notify">should I send Bye message ?
+ /// <param name='notify'>should I send Bye message ?
/// the thread managing the socket is stopped
///
/// </param>
@@ -231,7 +228,7 @@ namespace IvyBus /// <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 name='message'>the string that will be match-tested
/// </param>
/// <returns>the number of messages sent to the peer
///
@@ -264,7 +261,7 @@ namespace IvyBus /// <summary> compares two peers the id is the couple (host,service port).
/// </summary>
- /// <param name="clnt">the other peer
+ /// <param name='clnt'>the other peer
/// </param>
/// <returns>true if the peers are similir. This should not happen, it is bad
/// © ® (tm)
|