Miroirs/ruby-x11
1
0
Fork 0
mirror of https://github.com/vidarh/ruby-x11 synced 2024-12-26 09:59:02 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

add extra docs to packet.rb

Browse source
This commit is contained in:
Richard Ramsden 2012-03-11 14:37:50 -07:00
parent 3bee98236e
commit e6f63e926e
1 changed files with 18 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
lib/X11/packet.rb
View file

@ -6,6 +6,8 @@ module X11
attr_reader :packet
@@fields = []
# Takes a list of ruby objects and encodes them
# to binary data-types defined in X11::Encode
def self.create(*values)
@@fields.map do |name, type|
if :static == name
@ -21,6 +23,22 @@ module X11
end
end
# Information sent by the client at connection setup
#
# 1 byte-order
# #x42 MSB first
# #x6C LSB first
# 1 unused
# 2 CARD16 protocol-major-version
# 2 CARD16 protocol-minor-version
# 2 n length of authorization-protocol-name
# 2 d length of authorization-protocol-data
# 2 unused
# n STRING8 authorization-protocol-name
# p unused, p=pad(n)
# d STRING8 authorization-protocol-data
# q unused, q=pad(d)
#
class ClientHandshake < BasePacket
field :byte_order, Uint8
field :static, "\x00"