nghttp3 0.0.1

data/sig/nghttp3/error.rbs

@@ -0,0 +1,46 @@
+module Nghttp3
+  class Error < StandardError
+  end
+
+  class InvalidArgumentError < Error
+  end
+
+  class InvalidStateError < Error
+  end
+
+  class WouldBlockError < Error
+  end
+
+  class StreamInUseError < Error
+  end
+
+  class MalformedHTTPHeaderError < Error
+  end
+
+  class MalformedHTTPMessagingError < Error
+  end
+
+  class QPACKFatalError < Error
+  end
+
+  class QPACKHeaderTooLargeError < Error
+  end
+
+  class StreamNotFoundError < Error
+  end
+
+  class ConnClosingError < Error
+  end
+
+  class StreamDataOverflowError < Error
+  end
+
+  class FatalError < Error
+  end
+
+  class NoMemError < Error
+  end
+
+  class CallbackFailureError < Error
+  end
+end

data/sig/nghttp3/headers.rbs

@@ -0,0 +1,37 @@
+module Nghttp3
+  class Headers
+    include Enumerable[Array[String]]
+
+    def initialize: (?Hash[String | Symbol, String] hash) -> void
+
+    def []: (String | Symbol name) -> String?
+    def []=: (String | Symbol name, String | _ToS value) -> String
+
+    def delete: (String | Symbol name) -> String?
+    def key?: (String | Symbol name) -> bool
+    alias has_key? key?
+    alias include? key?
+
+    def each: () { (String name, String value) -> void } -> void
+            | () -> Enumerator[Array[String], void]
+
+    def merge!: (Hash[String | Symbol, String] | Headers other) -> self
+    def merge: (Hash[String | Symbol, String] | Headers other) -> Headers
+
+    def to_h: () -> Hash[String, String]
+    alias to_hash to_h
+
+    def size: () -> Integer
+    alias length size
+
+    def empty?: () -> bool
+    def clear: () -> self
+    def dup: () -> Headers
+
+    def inspect: () -> String
+
+    private
+
+    def normalize_name: (String | Symbol name) -> String
+  end
+end

data/sig/nghttp3/info.rbs

@@ -0,0 +1,7 @@
+module Nghttp3
+  class Info
+    def age: () -> Integer
+    def version_num: () -> Integer
+    def version_str: () -> String
+  end
+end

data/sig/nghttp3/nv.rbs

@@ -0,0 +1,9 @@
+module Nghttp3
+  class NV
+    def initialize: (String name, String value, ?flags: Integer) -> void
+
+    def name: () -> String
+    def value: () -> String
+    def flags: () -> Integer
+  end
+end

data/sig/nghttp3/qpack.rbs

@@ -0,0 +1,46 @@
+module Nghttp3
+  module QPACK
+    class Encoder
+      # Creates a new QPACK encoder
+      def initialize: (Integer max_dtable_capacity) -> void
+
+      # Encodes headers for a given stream
+      def encode: (Integer stream_id, Array[NV] headers) -> { prefix: String, data: String, encoder_stream: String }
+
+      # Reads decoder stream data
+      def read_decoder: (String data) -> Integer
+
+      # Sets the maximum dynamic table capacity
+      def max_dtable_capacity=: (Integer capacity) -> Integer
+
+      # Sets the maximum number of blocked streams
+      def max_blocked_streams=: (Integer num) -> Integer
+
+      # Returns the number of currently blocked streams
+      def num_blocked_streams: () -> Integer
+    end
+
+    class Decoder
+      # Creates a new QPACK decoder
+      def initialize: (Integer max_dtable_capacity, Integer max_blocked_streams) -> void
+
+      # Decodes headers from a stream
+      def decode: (Integer stream_id, String data, ?fin: bool) -> { headers: Array[{ name: String, value: String, token: Integer }]?, blocked: bool, consumed: Integer }
+
+      # Reads encoder stream data
+      def read_encoder: (String data) -> Integer
+
+      # Returns data to be sent on the decoder stream
+      def decoder_stream_data: () -> String
+
+      # Cancels decoding for the given stream
+      def cancel_stream: (Integer stream_id) -> void
+
+      # Sets the maximum dynamic table capacity
+      def max_dtable_capacity=: (Integer capacity) -> Integer
+
+      # Returns the current insert count
+      def insert_count: () -> Integer
+    end
+  end
+end

data/sig/nghttp3/request.rbs

@@ -0,0 +1,35 @@
+module Nghttp3
+  class Request
+    attr_reader method: String
+    attr_reader scheme: String
+    attr_reader authority: String?
+    attr_reader path: String
+    attr_reader headers: Headers
+    attr_reader body: String?
+
+    def initialize: (
+      method: String | Symbol,
+      path: String,
+      ?scheme: String,
+      ?authority: String?,
+      ?headers: Hash[String, String] | Headers,
+      ?body: String?
+    ) -> void
+
+    def to_nv_array: () -> Array[NV]
+    def body?: () -> bool
+    def inspect: () -> String
+
+    def self.get: (String url, ?headers: Hash[String, String]) -> Request
+    def self.post: (String url, ?body: String?, ?headers: Hash[String, String]) -> Request
+    def self.put: (String url, ?body: String?, ?headers: Hash[String, String]) -> Request
+    def self.delete: (String url, ?headers: Hash[String, String]) -> Request
+    def self.head: (String url, ?headers: Hash[String, String]) -> Request
+    def self.patch: (String url, ?body: String?, ?headers: Hash[String, String]) -> Request
+    def self.options: (String url, ?headers: Hash[String, String]) -> Request
+
+    private
+
+    def self.build_from_url: (String method, String url, ?body: String?, ?headers: Hash[String, String]) -> Request
+  end
+end

data/sig/nghttp3/response.rbs

@@ -0,0 +1,34 @@
+module Nghttp3
+  class Response
+    attr_reader stream_id: Integer
+    attr_accessor status: Integer?
+    attr_reader headers: Headers
+    attr_accessor body: String?
+
+    def initialize: (
+      stream_id: Integer,
+      ?status: Integer?,
+      ?headers: Hash[String, String]? | Headers?,
+      ?body: String?
+    ) -> void
+
+    def to_nv_array: () -> Array[NV]
+
+    def write_headers: (?Hash[String, String] extra_headers) -> self
+    def headers_sent?: () -> bool
+
+    def write: (String | _ToS chunk) -> self
+    def body_chunks: () -> Array[String]
+    def body_from_chunks: () -> String
+
+    def finish: () -> self
+    def finished?: () -> bool
+
+    def body?: () -> bool
+    def effective_body: () -> String?
+
+    def append_body: (String data) -> self
+
+    def inspect: () -> String
+  end
+end

data/sig/nghttp3/server.rbs

@@ -0,0 +1,33 @@
+module Nghttp3
+  class Server
+    attr_reader connection: Connection
+    attr_reader settings: Settings
+    attr_reader requests: Hash[Integer, Request]
+    attr_reader responses: Hash[Integer, Response]
+
+    def initialize: (?settings: Settings?) -> void
+
+    def bind_streams: (control: Integer, qpack_encoder: Integer, qpack_decoder: Integer) -> self
+    def streams_bound?: () -> bool
+
+    def on_request: () { (Request request, Response response) -> void } -> self
+
+    def pump_writes: () { (Integer stream_id, String data, bool fin) -> Integer? } -> self
+    def read_stream: (Integer stream_id, String data, ?fin: bool) -> Integer
+    def add_ack_offset: (Integer stream_id, Integer n) -> self
+
+    def close: () -> nil
+    def closed?: () -> bool
+
+    private
+
+    def setup_callbacks: () -> Callbacks
+    def on_begin_headers: (Integer stream_id) -> void
+    def on_recv_header: (Integer stream_id, String name, String value, Integer flags) -> void
+    def on_end_headers: (Integer stream_id, bool fin) -> void
+    def on_recv_data: (Integer stream_id, String data) -> void
+    def on_end_stream: (Integer stream_id) -> void
+    def on_stream_close: (Integer stream_id, Integer app_error_code) -> void
+    def process_request: (Integer stream_id) -> void
+  end
+end

data/sig/nghttp3/settings.rbs

@@ -0,0 +1,25 @@
+module Nghttp3
+  class Settings
+    def self.default: () -> Settings
+
+    def initialize: () -> void
+
+    def max_field_section_size: () -> Integer
+    def max_field_section_size=: (Integer value) -> Integer
+
+    def qpack_max_dtable_capacity: () -> Integer
+    def qpack_max_dtable_capacity=: (Integer value) -> Integer
+
+    def qpack_encoder_max_dtable_capacity: () -> Integer
+    def qpack_encoder_max_dtable_capacity=: (Integer value) -> Integer
+
+    def qpack_blocked_streams: () -> Integer
+    def qpack_blocked_streams=: (Integer value) -> Integer
+
+    def enable_connect_protocol: () -> bool
+    def enable_connect_protocol=: (boolish value) -> boolish
+
+    def h3_datagram: () -> bool
+    def h3_datagram=: (boolish value) -> boolish
+  end
+end

data/sig/nghttp3/stream_manager.rbs

@@ -0,0 +1,26 @@
+module Nghttp3
+  class StreamManager
+    BIDI_CLIENT: Integer
+    BIDI_SERVER: Integer
+    UNI_CLIENT: Integer
+    UNI_SERVER: Integer
+
+    def initialize: (is_server: bool) -> void
+
+    def allocate_bidi_stream_id: () -> Integer
+    def allocate_uni_stream_id: () -> Integer
+
+    def register_stream: (Integer stream_id, ?type: :bidi | :uni) -> void
+    def close_stream: (Integer stream_id) -> void
+    def remove_stream: (Integer stream_id) -> void
+
+    def stream_active?: (Integer stream_id) -> bool
+    def active_stream_ids: () -> Array[Integer]
+    def stream_info: (Integer stream_id) -> Hash[Symbol, Symbol]?
+
+    def client_initiated?: (Integer stream_id) -> bool
+    def server_initiated?: (Integer stream_id) -> bool
+    def bidirectional?: (Integer stream_id) -> bool
+    def unidirectional?: (Integer stream_id) -> bool
+  end
+end

data/sig/nghttp3.rbs

@@ -0,0 +1,64 @@
+module Nghttp3
+  VERSION: String
+
+  # nghttp3 library compile-time constants
+  NGHTTP3_VERSION: String
+  NGHTTP3_VERSION_NUM: Integer
+  NGHTTP3_VERSION_AGE: Integer
+
+  # nghttp3 error code constants
+  NGHTTP3_ERR_INVALID_ARGUMENT: Integer
+  NGHTTP3_ERR_INVALID_STATE: Integer
+  NGHTTP3_ERR_WOULDBLOCK: Integer
+  NGHTTP3_ERR_STREAM_IN_USE: Integer
+  NGHTTP3_ERR_MALFORMED_HTTP_HEADER: Integer
+  NGHTTP3_ERR_MALFORMED_HTTP_MESSAGING: Integer
+  NGHTTP3_ERR_QPACK_FATAL: Integer
+  NGHTTP3_ERR_QPACK_HEADER_TOO_LARGE: Integer
+  NGHTTP3_ERR_STREAM_NOT_FOUND: Integer
+  NGHTTP3_ERR_CONN_CLOSING: Integer
+  NGHTTP3_ERR_STREAM_DATA_OVERFLOW: Integer
+  NGHTTP3_ERR_FATAL: Integer
+  NGHTTP3_ERR_NOMEM: Integer
+  NGHTTP3_ERR_CALLBACK_FAILURE: Integer
+
+  # NV flag constants
+  NV_FLAG_NONE: Integer
+  NV_FLAG_NEVER_INDEX: Integer
+  NV_FLAG_NO_COPY_NAME: Integer
+  NV_FLAG_NO_COPY_VALUE: Integer
+  NV_FLAG_TRY_INDEX: Integer
+
+  # Data flag constants
+  DATA_FLAG_NONE: Integer
+  DATA_FLAG_EOF: Integer
+  DATA_FLAG_NO_END_STREAM: Integer
+
+  # HTTP/3 application error code constants
+  H3_NO_ERROR: Integer
+  H3_GENERAL_PROTOCOL_ERROR: Integer
+  H3_INTERNAL_ERROR: Integer
+  H3_STREAM_CREATION_ERROR: Integer
+  H3_CLOSED_CRITICAL_STREAM: Integer
+  H3_FRAME_UNEXPECTED: Integer
+  H3_FRAME_ERROR: Integer
+  H3_EXCESSIVE_LOAD: Integer
+  H3_ID_ERROR: Integer
+  H3_SETTINGS_ERROR: Integer
+  H3_MISSING_SETTINGS: Integer
+  H3_REQUEST_REJECTED: Integer
+  H3_REQUEST_CANCELLED: Integer
+  H3_REQUEST_INCOMPLETE: Integer
+  H3_MESSAGE_ERROR: Integer
+  H3_CONNECT_ERROR: Integer
+  H3_VERSION_FALLBACK: Integer
+
+  # Returns runtime version info, or nil if least_version requirement not met
+  def self.library_version: (?Integer least_version) -> Info?
+
+  # Returns true if the given error code represents a fatal error
+  def self.err_is_fatal?: (Integer error_code) -> bool
+
+  # Returns a textual representation of the given error code
+  def self.strerror: (Integer error_code) -> String
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: nghttp3
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yusuke Nakamura
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: "[WIP] Ruby bindings for nghttp3, a C library implementing HTTP/3 mapping
+  over QUIC and QPACK encoder/decoder."
+email:
+- yusuke1994525@gmail.com
+executables: []
+extensions:
+- ext/nghttp3/extconf.rb
+extra_rdoc_files: []
+files:
+- ".clang-format"
+- ".vscode/extensions.json"
+- ".vscode/settings.json"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- ext/nghttp3/extconf.rb
+- ext/nghttp3/nghttp3.c
+- ext/nghttp3/nghttp3.h
+- ext/nghttp3/nghttp3_callbacks.c
+- ext/nghttp3/nghttp3_connection.c
+- ext/nghttp3/nghttp3_nv.c
+- ext/nghttp3/nghttp3_qpack.c
+- ext/nghttp3/nghttp3_settings.c
+- lib/nghttp3.rb
+- lib/nghttp3/client.rb
+- lib/nghttp3/headers.rb
+- lib/nghttp3/request.rb
+- lib/nghttp3/response.rb
+- lib/nghttp3/server.rb
+- lib/nghttp3/stream_manager.rb
+- lib/nghttp3/version.rb
+- sig/nghttp3.rbs
+- sig/nghttp3/callbacks.rbs
+- sig/nghttp3/client.rbs
+- sig/nghttp3/connection.rbs
+- sig/nghttp3/error.rbs
+- sig/nghttp3/headers.rbs
+- sig/nghttp3/info.rbs
+- sig/nghttp3/nv.rbs
+- sig/nghttp3/qpack.rbs
+- sig/nghttp3/request.rbs
+- sig/nghttp3/response.rbs
+- sig/nghttp3/server.rbs
+- sig/nghttp3/settings.rbs
+- sig/nghttp3/stream_manager.rbs
+homepage: https://github.com/unasuke/nghttp3
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/unasuke/nghttp3
+  source_code_uri: https://github.com/unasuke/nghttp3
+  changelog_uri: https://github.com/unasuke/nghttp3/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: "[WIP] Ruby bindings for nghttp3, an HTTP/3 library"
+test_files: []