nl 0.4.1 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (54) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +28 -0
  3. data/lib/nl/async/dispatcher.rb +2 -2
  4. data/lib/nl/attribute_set.rb +19 -153
  5. data/lib/nl/attributes.rb +193 -0
  6. data/lib/nl/blocking_transport.rb +5 -5
  7. data/lib/nl/datagram.rb +4 -4
  8. data/lib/nl/datatypes/checked.rb +66 -0
  9. data/lib/nl/datatypes/defaults.rb +13 -0
  10. data/lib/nl/datatypes/scalar.rb +28 -0
  11. data/lib/nl/datatypes.rb +97 -125
  12. data/lib/nl/decoder.rb +79 -25
  13. data/lib/nl/encoder.rb +4 -6
  14. data/lib/nl/endian.rb +5 -4
  15. data/lib/nl/exchange.rb +18 -17
  16. data/lib/nl/family.rb +33 -15
  17. data/lib/nl/genl/client.rb +1 -0
  18. data/lib/nl/genl/protocol.rb +16 -3
  19. data/lib/nl/genl/wire.rb +10 -3
  20. data/lib/nl/genl.rb +0 -20
  21. data/lib/nl/message.rb +21 -0
  22. data/lib/nl/notification_router.rb +2 -5
  23. data/lib/nl/raw/client.rb +1 -1
  24. data/lib/nl/raw/protocol.rb +27 -21
  25. data/lib/nl/raw/wire.rb +21 -50
  26. data/lib/nl/raw.rb +1 -51
  27. data/lib/nl/{sub_message.rb → selector.rb} +13 -23
  28. data/lib/nl/socket.rb +21 -5
  29. data/lib/nl/version.rb +1 -1
  30. data/lib/nl.rb +2 -2
  31. data/sig/generated/nl/attribute_set.rbs +21 -29
  32. data/sig/generated/nl/attributes.rbs +51 -0
  33. data/sig/generated/nl/datagram.rbs +4 -4
  34. data/sig/generated/nl/datatypes/checked.rbs +31 -0
  35. data/sig/generated/nl/datatypes/defaults.rbs +11 -0
  36. data/sig/generated/nl/datatypes/scalar.rbs +11 -0
  37. data/sig/generated/nl/datatypes.rbs +38 -34
  38. data/sig/generated/nl/decoder.rbs +12 -4
  39. data/sig/generated/nl/encoder.rbs +1 -1
  40. data/sig/generated/nl/endian.rbs +1 -0
  41. data/sig/generated/nl/exchange.rbs +2 -2
  42. data/sig/generated/nl/family.rbs +40 -22
  43. data/sig/generated/nl/genl/protocol.rbs +3 -1
  44. data/sig/generated/nl/genl.rbs +0 -15
  45. data/sig/generated/nl/message.rbs +14 -0
  46. data/sig/generated/nl/raw/client.rbs +0 -1
  47. data/sig/generated/nl/raw/protocol.rbs +29 -43
  48. data/sig/generated/nl/raw/wire.rbs +0 -36
  49. data/sig/generated/nl/raw.rbs +0 -35
  50. data/sig/generated/nl/{sub_message.rbs → selector.rbs} +8 -19
  51. data/sig/generated/nl/socket.rbs +29 -10
  52. metadata +14 -6
  53. data/lib/nl/structured_payload.rb +0 -61
  54. data/sig/generated/nl/structured_payload.rbs +0 -25
@@ -2,66 +2,51 @@
2
2
 
3
3
  module Nl
4
4
  module Raw
5
- class AckFrame < Data
6
- attr_reader header(): untyped
5
+ class Ack < Data
6
+ def self.new: () -> instance
7
+ | () -> instance
7
8
 
8
- def self.new: (untyped header) -> instance
9
- | (header: untyped) -> instance
9
+ def self.members: () -> [ ]
10
10
 
11
- def self.members: () -> [ :header ]
12
-
13
- def members: () -> [ :header ]
11
+ def members: () -> [ ]
14
12
  end
15
13
 
16
- class ErrorFrame < Data
17
- attr_reader header(): untyped
18
-
14
+ class Error < Data
19
15
  attr_reader errno(): untyped
20
16
 
21
- def self.new: (untyped header, untyped errno) -> instance
22
- | (header: untyped, errno: untyped) -> instance
17
+ def self.new: (untyped errno) -> instance
18
+ | (errno: untyped) -> instance
23
19
 
24
- def self.members: () -> [ :header, :errno ]
20
+ def self.members: () -> [ :errno ]
25
21
 
26
- def members: () -> [ :header, :errno ]
22
+ def members: () -> [ :errno ]
27
23
  end
28
24
 
29
- class DoneFrame < Data
30
- attr_reader header(): untyped
31
-
25
+ class Done < Data
32
26
  attr_reader errno(): untyped
33
27
 
34
- def self.new: (untyped header, untyped errno) -> instance
35
- | (header: untyped, errno: untyped) -> instance
28
+ def self.new: (untyped errno) -> instance
29
+ | (errno: untyped) -> instance
36
30
 
37
- def self.members: () -> [ :header, :errno ]
31
+ def self.members: () -> [ :errno ]
38
32
 
39
- def members: () -> [ :header, :errno ]
33
+ def members: () -> [ :errno ]
40
34
  end
41
35
 
42
- class UnknownFrame < Data
43
- attr_reader header(): untyped
36
+ class Unknown < Data
37
+ def self.new: () -> instance
38
+ | () -> instance
44
39
 
45
- def self.new: (untyped header) -> instance
46
- | (header: untyped) -> instance
40
+ def self.members: () -> [ ]
47
41
 
48
- def self.members: () -> [ :header ]
49
-
50
- def members: () -> [ :header ]
42
+ def members: () -> [ ]
51
43
  end
52
44
 
53
- class DataFrame < Data
54
- attr_reader header(): untyped
55
-
56
- attr_reader message(): untyped
57
-
58
- def self.new: (untyped header, untyped message) -> instance
59
- | (header: untyped, message: untyped) -> instance
45
+ ACK: untyped
60
46
 
61
- def self.members: () -> [ :header, :message ]
47
+ DONE: untyped
62
48
 
63
- def members: () -> [ :header, :message ]
64
- end
49
+ UNKNOWN: untyped
65
50
 
66
51
  class Request < Data
67
52
  attr_reader type(): untyped
@@ -99,8 +84,11 @@ module Nl
99
84
 
100
85
  def encode_message: (untyped encoder, untyped _endpoint, untyped request, seq: untyped, pid: untyped) -> untyped
101
86
 
102
- # Decodes one frame using the reply class associated with its sequence.
103
- def decode_frame: (untyped _endpoint, untyped header, untyped payload, untyped message_class) -> untyped
87
+ # Returns a decoded reply or control result for one Netlink frame.
88
+ # @rbs (Endpoint endpoint, NlMsgHdr header, Decoder decoder, Class? message_class) -> (Message | Ack | Done | Error | Unknown)
89
+ def decode_frame: (Endpoint endpoint, NlMsgHdr header, Decoder decoder, Class? message_class) -> (Message | Ack | Done | Error | Unknown)
90
+
91
+ private def decode_message: (untyped _endpoint, untyped header, untyped decoder, untyped message_class) -> untyped
104
92
 
105
93
  def send_message: (untyped socket, untyped endpoint, untyped request, seq: untyped, pid: untyped) -> untyped
106
94
 
@@ -114,9 +102,7 @@ module Nl
114
102
 
115
103
  def notification_frame?: (untyped _endpoint, untyped header, untyped _payload) -> untyped
116
104
 
117
- def notification_class: (untyped _endpoint, untyped header, untyped _payload, untyped classes) -> untyped
118
-
119
- def decode_notification: (untyped endpoint, untyped header, untyped payload, untyped message_class) -> untyped
105
+ def decode_notification: (untyped _endpoint, untyped header, untyped payload, untyped classes) -> untyped
120
106
  end
121
107
  end
122
108
  end
@@ -111,41 +111,5 @@ module Nl
111
111
  # @rbs (Encoder encoder) -> void
112
112
  def encode: (Encoder encoder) -> void
113
113
  end
114
-
115
- # Fixed-format header prepended to every Netlink attribute.
116
- #
117
- # This corresponds to Linux's +struct nlattr+.
118
- #
119
- # @!attribute [rw] len
120
- # @return [Integer] attribute length in bytes, including this header but
121
- # excluding trailing alignment padding
122
- # @!attribute [rw] type
123
- # @return [Integer] attribute type combined with optional +NLA_F_+ flags
124
- class NlAttr < Struct[Integer]
125
- attr_accessor len(): Integer
126
-
127
- attr_accessor type(): Integer
128
-
129
- def self.new: (?Integer len, ?Integer type) -> instance
130
- | (?len: Integer, ?type: Integer) -> instance
131
- end
132
-
133
- class NlAttr
134
- FORMAT: untyped
135
-
136
- # Decodes an attribute header from the decoder's current position.
137
- #
138
- # @param [Decoder] decoder the source decoder
139
- # @return [NlAttr] the decoded header
140
- # @rbs (Decoder decoder) -> instance
141
- def self.decode: (Decoder decoder) -> instance
142
-
143
- # Encodes this attribute header at the encoder's current position.
144
- #
145
- # @param [Encoder] encoder the destination encoder
146
- # @return [void]
147
- # @rbs (Encoder encoder) -> void
148
- def encode: (Encoder encoder) -> void
149
- end
150
114
  end
151
115
  end
@@ -31,40 +31,5 @@ module Nl
31
31
  # @rbs (executor: executor?, notification_capacity: Integer) -> (Nl::Family::Session & instance)
32
32
  private def self.build_session: (executor: executor?, notification_capacity: Integer) -> (Nl::Family::Session & instance)
33
33
  end
34
-
35
- # Base class for raw Netlink messages.
36
- #
37
- # A message may contain a fixed header followed by a set of Netlink
38
- # attributes.
39
- class Message
40
- include Nl::StructuredPayload
41
-
42
- # @param [Object, nil] fixed_header the family-specific fixed header
43
- # @param [AttributeSet, nil] attributes the message's attributes
44
- # @rbs (?untyped fixed_header, ?AttributeSet? attributes) -> void
45
- def initialize: (?untyped fixed_header, ?AttributeSet? attributes) -> void
46
-
47
- # Appends an attribute to the message.
48
- #
49
- # @param [AttributeSet::Attribute] attribute the attribute to append
50
- # @return [void]
51
- # @rbs (AttributeSet::Attribute attribute) -> void
52
- def append_attribute: (AttributeSet::Attribute attribute) -> void
53
-
54
- # Decodes a raw Netlink message payload.
55
- #
56
- # @param [Decoder] decoder the source decoder
57
- # @param [Integer] type the message type from its Netlink header
58
- # @return [Message] the decoded message
59
- # @raise [RuntimeError] if +type+ does not match the message class's type
60
- # @rbs (Decoder decoder, type: Integer) -> instance
61
- def self.decode: (Decoder decoder, type: Integer) -> instance
62
-
63
- # Returns the attribute names accepted by this message.
64
- #
65
- # @return [Array<Symbol>] the attribute names
66
- # @rbs () -> Array[Symbol]
67
- private def self.attribute_names: () -> Array[Symbol]
68
- end
69
34
  end
70
35
  end
@@ -1,7 +1,9 @@
1
- # Generated from lib/nl/sub_message.rb with RBS::Inline
1
+ # Generated from lib/nl/selector.rb with RBS::Inline
2
2
 
3
3
  module Nl
4
4
  module Selector
5
+ EMPTY_VALUES: untyped
6
+
5
7
  class MissingSelectorValueError < StandardError
6
8
  attr_reader scope: untyped
7
9
 
@@ -43,7 +45,9 @@ module Nl
43
45
  end
44
46
 
45
47
  class State
46
- def initialize: (untyped local_count, untyped external) -> untyped
48
+ def self.for: (untyped local_selector_count, untyped external) -> untyped
49
+
50
+ def initialize: (untyped local_selector_count, untyped external) -> untyped
47
51
 
48
52
  def set_local: (untyped index, untyped value) -> untyped
49
53
 
@@ -52,23 +56,8 @@ module Nl
52
56
  def fetch_external: (untyped index) -> untyped
53
57
 
54
58
  def fetch: (untyped values, untyped key) -> untyped
55
- end
56
- end
57
-
58
- # A selector-specific payload containing an optional fixed header followed by
59
- # an optional set of Netlink attributes.
60
- class SubMessage
61
- include StructuredPayload
62
- end
63
-
64
- # An unrecognized selector-specific payload retained without interpretation.
65
- class RawSubMessage < SubMessage
66
- attr_reader payload: untyped
67
-
68
- attr_reader nlattr_type_flags: untyped
69
59
 
70
- def initialize: (untyped payload, nlattr_type_flags: untyped) -> untyped
71
-
72
- def encode: (untyped encoder, ?external_selectors: untyped) -> untyped
60
+ EMPTY: untyped
61
+ end
73
62
  end
74
63
  end
@@ -4,10 +4,12 @@ module Nl
4
4
  # Netlink socket
5
5
  class Socket < ::Socket
6
6
  module Constants
7
- # From include/linux/socket.h
7
+ # From linux/socket.h
8
+ # -
8
9
  PF_NETLINK: untyped
9
10
 
10
- # From include/uapi/linux/netlink.h
11
+ # From linux/netlink.h
12
+ # -
11
13
  SOL_NETLINK: ::Integer
12
14
 
13
15
  NETLINK_ADD_MEMBERSHIP: ::Integer
@@ -17,24 +19,41 @@ module Nl
17
19
 
18
20
  include Constants
19
21
 
20
- def self.pack_sockaddr_nl: (untyped pid, untyped groups) -> untyped
22
+ # Packs Netlink socket address
23
+ #
24
+ # @rbs (Integer pid, Integer groups) -> String
25
+ def self.pack_sockaddr_nl: (Integer pid, Integer groups) -> String
21
26
 
22
27
  alias self.sockaddr_nl self.pack_sockaddr_nl
23
28
 
24
- def self.unpack_sockaddr_nl: (untyped sockaddr) -> untyped
29
+ # Unpacks Netlink socket address
30
+ #
31
+ # @rbs (String) -> [Integer, Integer]
32
+ def self.unpack_sockaddr_nl: (String) -> [ Integer, Integer ]
25
33
 
26
- # @param protonum [Integer] Netlink protocol number
27
- def initialize: (untyped protonum) -> untyped
34
+ # @param [Integer] protonum Netlink protocol number
35
+ # @rbs (Integer) -> void
36
+ def initialize: (Integer) -> void
28
37
 
29
- def self.open: (untyped protonum) -> untyped
38
+ # Opens a Netlink socket for the specified protocol number.
39
+ #
40
+ # @rbs (Integer protonum) -> instance
41
+ # | [R] (Integer protonum) { (instance) -> R } -> R
42
+ def self.open: (Integer protonum) -> instance
43
+ | [R] (Integer protonum) { (instance) -> R } -> R
30
44
 
31
45
  # @return [Integer] Local Netlink port ID assigned to this socket
32
- def local_port_id: () -> untyped
46
+ # @rbs () -> Integer
47
+ def local_port_id: () -> Integer
33
48
 
34
49
  # Adds this socket to a Netlink multicast group.
35
- def add_membership: (untyped group_id) -> untyped
50
+ #
51
+ # @rbs (Integer group_id) -> void
52
+ def add_membership: (Integer group_id) -> void
36
53
 
37
54
  # Removes this socket from a Netlink multicast group.
38
- def drop_membership: (untyped group_id) -> untyped
55
+ #
56
+ # @rbs (Integer group_id) -> void
57
+ def drop_membership: (Integer group_id) -> void
39
58
  end
40
59
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: nl
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.4.1
4
+ version: 0.5.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Kasumi Hanazuki
@@ -29,11 +29,15 @@ files:
29
29
  - lib/nl/async/mailbox.rb
30
30
  - lib/nl/async/operation.rb
31
31
  - lib/nl/attribute_set.rb
32
+ - lib/nl/attributes.rb
32
33
  - lib/nl/bitfield32.rb
33
34
  - lib/nl/blocking_transport.rb
34
35
  - lib/nl/connection.rb
35
36
  - lib/nl/datagram.rb
36
37
  - lib/nl/datatypes.rb
38
+ - lib/nl/datatypes/checked.rb
39
+ - lib/nl/datatypes/defaults.rb
40
+ - lib/nl/datatypes/scalar.rb
37
41
  - lib/nl/decoder.rb
38
42
  - lib/nl/encoder.rb
39
43
  - lib/nl/endian.rb
@@ -44,16 +48,16 @@ files:
44
48
  - lib/nl/genl/client.rb
45
49
  - lib/nl/genl/protocol.rb
46
50
  - lib/nl/genl/wire.rb
51
+ - lib/nl/message.rb
47
52
  - lib/nl/notification.rb
48
53
  - lib/nl/notification_router.rb
49
54
  - lib/nl/raw.rb
50
55
  - lib/nl/raw/client.rb
51
56
  - lib/nl/raw/protocol.rb
52
57
  - lib/nl/raw/wire.rb
58
+ - lib/nl/selector.rb
53
59
  - lib/nl/sequence_allocator.rb
54
60
  - lib/nl/socket.rb
55
- - lib/nl/structured_payload.rb
56
- - lib/nl/sub_message.rb
57
61
  - lib/nl/version.rb
58
62
  - sig/generated/nl.rbs
59
63
  - sig/generated/nl/async.rbs
@@ -62,11 +66,15 @@ files:
62
66
  - sig/generated/nl/async/mailbox.rbs
63
67
  - sig/generated/nl/async/operation.rbs
64
68
  - sig/generated/nl/attribute_set.rbs
69
+ - sig/generated/nl/attributes.rbs
65
70
  - sig/generated/nl/bitfield32.rbs
66
71
  - sig/generated/nl/blocking_transport.rbs
67
72
  - sig/generated/nl/connection.rbs
68
73
  - sig/generated/nl/datagram.rbs
69
74
  - sig/generated/nl/datatypes.rbs
75
+ - sig/generated/nl/datatypes/checked.rbs
76
+ - sig/generated/nl/datatypes/defaults.rbs
77
+ - sig/generated/nl/datatypes/scalar.rbs
70
78
  - sig/generated/nl/decoder.rbs
71
79
  - sig/generated/nl/encoder.rbs
72
80
  - sig/generated/nl/endian.rbs
@@ -77,23 +85,23 @@ files:
77
85
  - sig/generated/nl/genl/client.rbs
78
86
  - sig/generated/nl/genl/protocol.rbs
79
87
  - sig/generated/nl/genl/wire.rbs
88
+ - sig/generated/nl/message.rbs
80
89
  - sig/generated/nl/notification.rbs
81
90
  - sig/generated/nl/notification_router.rbs
82
91
  - sig/generated/nl/raw.rbs
83
92
  - sig/generated/nl/raw/client.rbs
84
93
  - sig/generated/nl/raw/protocol.rbs
85
94
  - sig/generated/nl/raw/wire.rbs
95
+ - sig/generated/nl/selector.rbs
86
96
  - sig/generated/nl/sequence_allocator.rbs
87
97
  - sig/generated/nl/socket.rbs
88
- - sig/generated/nl/structured_payload.rbs
89
- - sig/generated/nl/sub_message.rbs
90
98
  - sig/generated/nl/version.rbs
91
99
  homepage: https://github.com/hanazuki/nl
92
100
  licenses:
93
101
  - MIT
94
102
  metadata:
95
103
  homepage_uri: https://github.com/hanazuki/nl
96
- source_code_uri: https://github.com/hanazuki/nl/tree/v0.4.1
104
+ source_code_uri: https://github.com/hanazuki/nl/tree/v0.5.0
97
105
  changelog_uri: https://github.com/hanazuki/nl/blob/master/CHANGELOG.md
98
106
  rdoc_options: []
99
107
  require_paths:
@@ -1,61 +0,0 @@
1
- module Nl
2
- # Shared handling for a payload containing an optional fixed header followed
3
- # by an optional attribute set.
4
- module StructuredPayload
5
- def self.included(base)
6
- base.extend(ClassMethods)
7
- end
8
-
9
- attr_accessor :fixed_header, :attributes
10
-
11
- def initialize(fixed_header = nil, attributes = nil)
12
- @fixed_header = fixed_header
13
- @attributes = attributes
14
- end
15
-
16
- module ClassMethods
17
- def from_params(params = nil, external_selectors: [], **keywords)
18
- params = (params || {}).merge(keywords).transform_keys(&:to_sym)
19
-
20
- if self::FIXED_HEADER
21
- header_params = params.slice(*self::FIXED_HEADER.members)
22
- fixed_header = self::FIXED_HEADER.new(**header_params)
23
- else
24
- header_params = {}
25
- end
26
-
27
- if self::ATTRIBUTE_SET
28
- attribute_params = params.slice(*attribute_names)
29
- attributes = self::ATTRIBUTE_SET.build_attributes(
30
- attribute_params,
31
- external_selectors:,
32
- )
33
- else
34
- attribute_params = {}
35
- end
36
-
37
- unknown = params.keys - header_params.keys - attribute_params.keys
38
- unless unknown.empty?
39
- raise ArgumentError, "unknown parameters: #{unknown.join(', ')}"
40
- end
41
-
42
- new(fixed_header, attributes)
43
- end
44
-
45
- def decode(decoder, external_selectors: [])
46
- fixed_header = self::FIXED_HEADER&.decode(decoder)
47
- attributes = self::ATTRIBUTE_SET&.decode(decoder, external_selectors:)
48
- new(fixed_header, attributes)
49
- end
50
-
51
- private def attribute_names
52
- self::ATTRIBUTE_SET::BY_NAME.keys
53
- end
54
- end
55
-
56
- def encode(encoder, external_selectors: [])
57
- fixed_header&.encode(encoder)
58
- attributes&.encode(encoder, external_selectors:)
59
- end
60
- end
61
- end
@@ -1,25 +0,0 @@
1
- # Generated from lib/nl/structured_payload.rb with RBS::Inline
2
-
3
- module Nl
4
- # Shared handling for a payload containing an optional fixed header followed
5
- # by an optional attribute set.
6
- module StructuredPayload
7
- def self.included: (untyped base) -> untyped
8
-
9
- attr_accessor fixed_header: untyped
10
-
11
- attr_accessor attributes: untyped
12
-
13
- def initialize: (?untyped fixed_header, ?untyped attributes) -> untyped
14
-
15
- module ClassMethods
16
- def from_params: (?untyped params, ?external_selectors: untyped, **untyped keywords) -> untyped
17
-
18
- def decode: (untyped decoder, ?external_selectors: untyped) -> untyped
19
-
20
- private def attribute_names: () -> untyped
21
- end
22
-
23
- def encode: (untyped encoder, ?external_selectors: untyped) -> untyped
24
- end
25
- end