move example projects into a subfolder
continuous-integration/drone/push Build is failing Details

This commit is contained in:
Ben Harris 2020-05-05 21:32:08 -04:00
parent 2c4e412c18
commit b3c1a9a929
8 changed files with 110 additions and 100 deletions

View File

@ -6,7 +6,7 @@
</PropertyGroup>
<ItemGroup>
<ProjectReference Include="..\IrcStates\IrcStates.csproj" />
<ProjectReference Include="..\..\IrcStates\IrcStates.csproj" />
</ItemGroup>
</Project>

View File

@ -6,7 +6,7 @@
</PropertyGroup>
<ItemGroup>
<ProjectReference Include="..\IrcTokens\IrcTokens.csproj" />
<ProjectReference Include="..\..\IrcTokens\IrcTokens.csproj" />
</ItemGroup>
</Project>

View File

@ -5,11 +5,11 @@ VisualStudioVersion = 16.0.30011.22
MinimumVisualStudioVersion = 10.0.40219.1
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "IrcTokens", "IrcTokens\IrcTokens.csproj", "{9E812F45-B2CD-42D2-8378-EBEBF8697905}"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "TokensSample", "TokensSample\TokensSample.csproj", "{A45DA39B-6B47-4713-8049-3B36E0235B67}"
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "TokensSample", "Examples\Tokens\TokensSample.csproj", "{A45DA39B-6B47-4713-8049-3B36E0235B67}"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "IrcStates", "IrcStates\IrcStates.csproj", "{233E3CB4-61F1-4368-9139-7E9F4A58ED2D}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "StatesSample", "StatesSample\StatesSample.csproj", "{BC9F6696-9D83-4F7A-9E15-CE4D3626C1AF}"
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "StatesSample", "Examples\States\StatesSample.csproj", "{BC9F6696-9D83-4F7A-9E15-CE4D3626C1AF}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{1A85EB22-D7B4-417F-AC3B-DAFD97DDEA08}"
ProjectSection(SolutionItems) = preProject

96
IrcTokens/README.md Normal file
View File

@ -0,0 +1,96 @@
# irctokens
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 [Examples/Tokens/Client.cs](Examples/Tokens/Client.cs)
public class Client
{
private readonly byte[] _bytes;
private readonly StatefulDecoder _decoder;
private readonly StatefulEncoder _encoder;
private readonly Socket _socket;
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);
while (!_socket.Connected) Thread.Sleep(1000);
Send(new Line {Command = "NICK", Params = new List<string> {"tokensbot"}});
Send(new Line {Command = "USER", Params = new List<string> {"tokensbot", "0", "*", "real name"}});
while (true)
{
var bytesReceived = _socket.Receive(_bytes);
if (bytesReceived == 0)
{
Console.WriteLine("! disconnected");
_socket.Shutdown(SocketShutdown.Both);
_socket.Close();
break;
}
var lines = _decoder.Push(_bytes, bytesReceived);
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> {"#test"}});
break;
case "PRIVMSG":
Send(new Line
{
Command = "PRIVMSG", Params = new List<string> {line.Params[0], "hello there"}
});
break;
}
}
}
}
private void Send(Line line)
{
Console.WriteLine($"> {line.Format()}");
_encoder.Push(line);
while (_encoder.PendingBytes.Length > 0)
_encoder.Pop(_socket.Send(_encoder.PendingBytes, SocketFlags.None));
}
}

106
README.md
View File

@ -1,102 +1,16 @@
# irctokens
# IrcSharp
[![Build Status](https://drone.tildegit.org/api/badges/ben/ircsharp/status.svg)](https://drone.tildegit.org/ben/ircsharp)
[![Build Status](https://drone.tildegit.org/api/badges/ben/irctokens/status.svg)](https://drone.tildegit.org/ben/irctokens)
this is a c\# port of jesopo's [irctokens](
https://github.com/jesopo/irctokens)
this is a collection of c\# projects to tokenize, parse, and maintain
state for IRC clients.
## usage
unless otherwise noted, this is mostly a port of jesopo's python libraries.
### tokenization
- [irctokens](https://github.com/jesopo/irctokens)
- [ircstates](https://github.com/jesopo/ircstates)
- [ircrobots](https://github.com/jesopo/ircrobots)
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 [TokensSample/Client.cs](TokensSample/Client.cs)
public class Client
{
private readonly byte[] _bytes;
private readonly StatefulDecoder _decoder;
private readonly StatefulEncoder _encoder;
private readonly Socket _socket;
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);
while (!_socket.Connected) Thread.Sleep(1000);
Send(new Line {Command = "NICK", Params = new List<string> {"tokensbot"}});
Send(new Line {Command = "USER", Params = new List<string> {"tokensbot", "0", "*", "real name"}});
while (true)
{
var bytesReceived = _socket.Receive(_bytes);
if (bytesReceived == 0)
{
Console.WriteLine("! disconnected");
_socket.Shutdown(SocketShutdown.Both);
_socket.Close();
break;
}
var lines = _decoder.Push(_bytes, bytesReceived);
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> {"#test"}});
break;
case "PRIVMSG":
Send(new Line
{
Command = "PRIVMSG", Params = new List<string> {line.Params[0], "hello there"}
});
break;
}
}
}
}
private void Send(Line line)
{
Console.WriteLine($"> {line.Format()}");
_encoder.Push(line);
while (_encoder.PendingBytes.Length > 0)
_encoder.Pop(_socket.Send(_encoder.PendingBytes, SocketFlags.None));
}
}
## contact
come say hi on [\#irctokens on irc.tilde.chat](https://web.tilde.chat/?join=irctokens)
discussion and support on irc: [#irctokens](
https://web.tilde.chat/?join=irctokens)