add example to README.md
continuous-integration/drone/push Build is passing
Details
continuous-integration/drone/push Build is passing
Details
This commit is contained in:
parent
c1c77aaf8e
commit
f77737bb90
86
README.md
86
README.md
|
@ -3,3 +3,89 @@
|
|||
this is a c\# port of jesopo's [irctokens](
|
||||
https://github.com/jesopo/irctokens)
|
||||
|
||||
## usage
|
||||
|
||||
### tokenization
|
||||
|
||||
using IrcTokens;
|
||||
|
||||
...
|
||||
|
||||
var line = new Line("@id=123 :ben!~ben@host.tld PRIVMSG #channel :hello there!");
|
||||
Console.WriteLine(line);
|
||||
Console.WriteLine(line.Format());
|
||||
|
||||
### formatting
|
||||
|
||||
var line = new Line {Command = "USER", Params = new List<string> {"user", "0", "*", "real name"}};
|
||||
Console.WriteLine(line);
|
||||
Console.WriteLine(line.Format());
|
||||
|
||||
### stateful
|
||||
|
||||
see the full example in [Sample/Client.cs](Sample/Client.cs)
|
||||
|
||||
public class Client
|
||||
{
|
||||
private readonly Socket _socket;
|
||||
private readonly StatefulDecoder _decoder;
|
||||
private readonly StatefulEncoder _encoder;
|
||||
private readonly byte[] _bytes;
|
||||
|
||||
public Client()
|
||||
{
|
||||
_decoder = new StatefulDecoder();
|
||||
_encoder = new StatefulEncoder();
|
||||
_socket = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.IP);
|
||||
_bytes = new byte[1024];
|
||||
}
|
||||
|
||||
public void Start()
|
||||
{
|
||||
_socket.Connect("127.0.0.1", 6667);
|
||||
|
||||
Send(new Line {Command = "USER", Params = new List<string> {"username", "0", "*", "real name"}});
|
||||
Send(new Line {Command = "NICK", Params = new List<string> {"statefulbot"}});
|
||||
|
||||
while (true)
|
||||
{
|
||||
var bytesReceived = _socket.Receive(_bytes);
|
||||
var lines = _decoder.Push(_bytes);
|
||||
|
||||
if (lines.Count == 0)
|
||||
{
|
||||
Console.WriteLine("! disconnected");
|
||||
_socket.Shutdown(SocketShutdown.Both);
|
||||
break;
|
||||
}
|
||||
|
||||
foreach (var line in lines)
|
||||
{
|
||||
Console.WriteLine($"< {line.Format()}");
|
||||
|
||||
switch (line.Command)
|
||||
{
|
||||
case "PING":
|
||||
Send(new Line {Command = "PONG", Params = line.Params});
|
||||
break;
|
||||
case "001":
|
||||
Send(new Line {Command = "JOIN", Params = new List<string> {"#channel"}});
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private void Send(Line line)
|
||||
{
|
||||
Console.WriteLine($"> {line.Format()}");
|
||||
_encoder.Push(line);
|
||||
while (_encoder.PendingBytes.Length > 0)
|
||||
_encoder.Pop(_socket.Send(_encoder.PendingBytes));
|
||||
}
|
||||
}
|
||||
|
||||
## contact
|
||||
|
||||
come say hi on [\#irctokens on irc.tilde.chat](https://web.tilde.chat/?join=irctokens)
|
||||
|
||||
|
|
Loading…
Reference in New Issue