Class: OnStomp::Connections::Serializers::Stomp_1_1

Inherits:

Object

• Object
• OnStomp::Connections::Serializers::Stomp_1_1

show all

Includes:

Stomp_1

Defined in:

lib/onstomp/connections/serializers/stomp_1_1.rb

Overview

Constant Summary

CHARACTER_ESCAPES =

Mapping of characters to their appropriate escape sequences. This is used when escaping headers for frames being written to the stream.

{ ':' => "\\c", "\n" => "\\n", "\\" => "\\\\" }

ESCAPE_SEQUENCES =

Mapping of escape sequences to their appropriate characters. This is used when unescaping headers being read from the stream.

Hash[CHARACTER_ESCAPES.map { |k,v| [v,k] }]

Instance Method Summary (collapse)

• - (String) encode_header(s)

  Encodes the given string to 'UTF-8'.

• - (String) escape_header(s)

  Escapes a header name or value by replacing special characters with their appropriate escape sequences.

• - (OnStomp::Components::Frame) force_body_encoding(f)

  Forces the encoding of the given frame's body to match its charset.

• - (String) force_header_encoding(s)

  Forces the encoding of the given string to 'UTF-8'.

• - (String) frame_to_string(frame)

  Converts a frame to a string.

• - (Stomp_1_1) initialize constructor

  Creates a new serializer and calls OnStomp::Connections::Serializers::Stomp_1#reset_parser.

• - (OnStomp::Components::Frame) make_ct(f)

  Set an appropriate +content-type+ header with charset parameter for frames with a text body.

• - (Object) prepare_parsed_frame(frame)

  Forces the frame's body to match the charset specified in its content-type header, if applicable.

• - ([String, String]) split_header(str)

  Splits a header line into a header name / header value pair at the first ':' character unescapes them, and returns the pair.

• - (String) unescape_header(s)

  Unescapes a header name or pair parsed from the read buffer by converting known escape sequences into their special characters.

Methods included from Stomp_1

#bytes_to_frame, #finish_body, #finish_command, #finish_header_line, #frame_to_bytes, #frame_to_string_base, #parse_body, #parse_command, #parse_header_line, #parser_flush, #reset_parser

16
17
18

# File 'lib/onstomp/connections/serializers/stomp_1_1.rb', line 16

def initialize
  reset_parser
end

79

# File 'lib/onstomp/connections/serializers/stomp_1_1.rb', line 79

def encode_header(s); s; end

34
35
36

# File 'lib/onstomp/connections/serializers/stomp_1_1.rb', line 34

def escape_header s
  encode_header(s).gsub(/[:\n\\\\]/) { |c| CHARACTER_ESCAPES[c] }
end

91

# File 'lib/onstomp/connections/serializers/stomp_1_1.rb', line 91

def force_body_encoding(f); f; end

86

# File 'lib/onstomp/connections/serializers/stomp_1_1.rb', line 86

def force_header_encoding(s); s; end

23
24
25
26
27

# File 'lib/onstomp/connections/serializers/stomp_1_1.rb', line 23

def frame_to_string frame
  frame_to_string_base(make_ct(frame)) do |k,v|
    "#{escape_header k}:#{escape_header v}\n"
  end
end

132

# File 'lib/onstomp/connections/serializers/stomp_1_1.rb', line 132

def make_ct(f); f; end

70
71
72

# File 'lib/onstomp/connections/serializers/stomp_1_1.rb', line 70

def prepare_parsed_frame frame
  force_body_encoding frame
end

58
59
60
61
62
63
64
65

# File 'lib/onstomp/connections/serializers/stomp_1_1.rb', line 58

def split_header(str)
  col = str.index(':')
  unless col
    raise OnStomp::MalformedHeaderError, "unterminated header: '#{str}'"
  end
  [ unescape_header(str[0...col]),
    unescape_header(str[(col+1)..-1]) ]
end

46
47
48
49
50

# File 'lib/onstomp/connections/serializers/stomp_1_1.rb', line 46

def unescape_header s
  force_header_encoding(s).gsub(/\\.?/) do |c|
    ESCAPE_SEQUENCES[c] || raise(OnStomp::InvalidHeaderEscapeSequenceError, "#{c}")
  end
end