libSnp31LowLevel - fullphat/snarl_network_protocol GitHub Wiki

Overview

This library provides developers with the ability to hand-craft custom SNP 3.1 requests, responses and signals either by building the request from the bottom-up, or by translating a stream of bytes received by a socket into a viable SNP 3.1 message which can then be queried and modified.

Use Cases

  • For tools which want to be able to translate an ASCII string into a SNP 3.1 request (e.g. a variant of heySnarl that uses SNP 3.1)
  • Translate a Snarl request sent in a different format into SNP 3.1 (or vice versa)
  • Applications wishing to receive and process SNP 3.1 requests
  • Applications wishing to issue SNP 3.1 signals

Objects

SNP31Request

Constructor

SNP31Request()
SNP31Request(Action action)
SNP31Request(string message)

Properties

Name Type Description

Methods

Events

None

SNP31Response

Constructor

SNP31Response()
SNP31Response(ResponseTypes type, SnarlStatusCode statusCode)
SNP31Response(string message)

Properties

Name Type Description

Methods

Events

None

SNP31Signal

Constructor

SNP31Signal()
SNP31Signal(SignalTypes type)
SNP31Signal(SignalTypes type, SnarlStatusCode statusCode)

Properties

Name Type Description

Methods

Events

None