hrpc.net 1.0.0

hrpc.net

a small hrpc utility library. only supports client-side usage for now

Documentation

Requests

var messageRequest = new Message() { content: "Hi!" };

HttpClient client = ...;

// if you need to add headers (for authorization, for example)
client.DefaultRequestHeaders.Add("Authorization", "token");

await client.HrpcUnaryAsync<Message, Empty>("http://localhost:2289/chat.Chat/SendMessage", messageRequest);

Streams

var stream = new StreamClient<Message>();

// if you need to add headers
var stream = new StreamClient<Message>(new() { { "Authorization", "token" } });

await client.Connect("http://localhost:2289/chat.Chat/StreamMessages", new Chat.Empty());

while (client.State == WebSocketState.Open)
{
    var message = await client.Read();
    _ = HandleMessageReceived(message);
}

Console.WriteLine($"Stream client closed with status {client.CloseStatus}!");

Serializing / Deserializing

// usage in HTTP requests
byte[] data = ...;
int statusCode = ...;
MyClass parsed = Proto.Deserialize<MyClass>(data, statusCode); // throws HrpcError if statusCode != 200

// usage in streams
byte[] data = ...;
MyClass parsed = Proto.Deserialize<MyClass>(data); // throws HrpcError if serialized message begins with 1 (error)

Errors

Any errors thrown by this library are subclasses of HrpcError.

public class HrpcError : Exception
{
    public readonly string Identifier;
    public readonly string HumanMessage;
    public readonly byte[] Details;
}

public class UnknownHrpcError : HrpcError {}
public class InternalServerError : HrpcError {}

public class RateLimited : HrpcError {
    public readonly uint RetryAfter;
}

public class NotFound : HrpcError {}
public class NotImplemented : HrpcError {}
public class Unavailable : HrpcError {}
public class BadUnaryRequest : HrpcError {}
public class BadStreamingRequest : HrpcError {}

License

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to http://unlicense.org/