Class: PostgresPR::Message

Inherits:
Object
  • Object
show all
Defined in:
lib/postgres-pr/message.rb

Overview

Base class representing a PostgreSQL protocol message

Constant Summary collapse

MsgTypeMap =

One character message-typecode to class map

Hash.new { UnknownMessageType }

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.create(buffer) ⇒ Object 



46
47
48
49
50
 
# File 'lib/postgres-pr/message.rb', line 46

def self.create(buffer)
  obj = allocate
  obj.parse(buffer)
  obj
end

.dump(*args) ⇒ Object 



52
53
54
 
# File 'lib/postgres-pr/message.rb', line 52

def self.dump(*args)
  new(*args).dump
end

.fields(*attribs) ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/postgres-pr/message.rb', line 71

def self.fields(*attribs)
  names = attribs.map {|name, type| name.to_s}
  arg_list = names.join(", ")
  ivar_list = names.map {|name| "@" + name }.join(", ")
  sym_list = names.map {|name| ":" + name }.join(", ")
  class_eval %[
    attr_accessor #{ sym_list } 
    def initialize(#{ arg_list })
      #{ ivar_list } = #{ arg_list }
    end
  ] 
end

.read(stream, startup = false) ⇒ Object

Raises:



31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/postgres-pr/message.rb', line 31

def self.read(stream, startup=false)
  type = stream.readbytes(1).unpack('C').first unless startup
  length = stream.readbytes(4).unpack('N').first  # FIXME: length should be signed, not unsigned

  raise ParseError unless length >= 4

  # initialize buffer
  buffer = Buffer.of_size(startup ? length : 1+length)
  buffer.write_byte(type) unless startup
  buffer.write_int32_network(length)
  buffer.copy_from_stream(stream, length-4)
  
  (startup ? StartupMessage : MsgTypeMap[type]).create(buffer)
end

.register_message_type(type) ⇒ Object

Raises:

  • (ArgumentError) 


21
22
23
24
25
26
27
28
29
 
# File 'lib/postgres-pr/message.rb', line 21

def self.register_message_type(type)
  raise ArgumentError if type < 0 or type > 255
  raise "duplicate message type registration" if MsgTypeMap.has_key? type

  MsgTypeMap[type] = self

  self.const_set(:MsgType, type) 
  class_eval "def message_type; MsgType end"
end

Instance Method Details

#dump(body_size = 0) {|buffer| ... } ⇒ Object

Yields:

  • (buffer)

Raises:



56
57
58
59
60
61
62
63
 
# File 'lib/postgres-pr/message.rb', line 56

def dump(body_size=0)
  buffer = Buffer.of_size(5 +  body_size)
  buffer.write_byte(self.message_type)
  buffer.write_int32_network(4 + body_size)
  yield buffer if block_given?
  raise DumpError  unless buffer.at_end?
  return buffer.content
end

#parse(buffer) {|buffer| ... } ⇒ Object

Yields:

  • (buffer)

Raises:



65
66
67
68
69
 
# File 'lib/postgres-pr/message.rb', line 65

def parse(buffer)
  buffer.position = 5
  yield buffer if block_given?
  raise ParseError, buffer.inspect unless buffer.at_end?
end