123456789_123456789_123456789_123456789_123456789_

Module: Mongo::Protocol::Serializers::Sections Private

Relationships & Source Files
Namespace Children
Modules:
PayloadOne, PayloadZero
Defined in: lib/mongo/protocol/serializers.rb

Overview

MongoDB wire protocol serialization strategy for a Section of OP_MSG.

Serializes and de-serializes a list of Sections.

Since:

  • 2.5.0

Class Attribute Summary

  • .size_limited? ⇒ true readonly Internal use only

    Whether there can be a size limit on this type after serialization.

Class Method Summary

Class Attribute Details

.size_limited? ⇒ true (readonly)

Whether there can be a size limit on this type after serialization.

Returns:

  • (true) —

    Documents can be size limited upon serialization.

Since:

  • 2.5.0

[ GitHub ] 

  


# File 'lib/mongo/protocol/serializers.rb', line 240



def self.size_limited?
  true
end


  







Class Method Details



  

    .deserialize(buffer, options = {})  ⇒ Array<BSON::Document> 
  



  

    

Deserializes a section of an OP_MSG from the IO stream.


  





  
Parameters:


    
  
  • 
    buffer
    (BSON::ByteBuffer)
—    
    

    Buffer containing the sections.
    

    
  
    • 
  
  • 
    options
    (Hash)
    (defaults to: {})
  
    • 


    
Options Hash (options):

    
    
        
  • 
          :deserialize_as_bson
          (Boolean)
            — 
    

    Whether to perform section deserialization using BSON types instead of native Ruby types wherever possible.
    

            
    • 
    


Returns:


    
  
  • 
    (Array<BSON::Document>)
—    
    

    Deserialized sections.
    

    
  
    • 



Since:


    
  
  • 
    
    

    2.5.0
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongo/protocol/serializers.rb', line 219



def self.deserialize(buffer, options = {})
  end_length = (@flag_bits & Msg::FLAGS.index(:checksum_present)) == 1 ? 32 : 0
  sections = []
  until buffer.length == end_length
    case byte = buffer.get_byte
    when PayloadZero::TYPE_BYTE
      sections << PayloadZero.deserialize(buffer, options)
    when PayloadOne::TYPE_BYTE
      sections += PayloadOne.deserialize(buffer, options)
    else
      raise Error::UnknownPayloadType.new(byte)
    end
  end
  sections
end


  








  

    .serialize(buffer, value, max_bson_size = nil, validating_keys = nil)  ⇒ BSON::ByteBuffer 
  



  

    

Serializes the sections of an OP_MSG, payload type 0 or 1.


  





  
Parameters:


    
  
  • 
    buffer
    (BSON::ByteBuffer)
—    
    

    Buffer to receive the serialized Sections.
    

    
  
    • 
  
  • 
    value
    (Array<Hash, BSON::Document>)
—    
    

    The sections to be serialized.
    

    
  
    • 
  
  • 
    max_bson_size
    (Fixnum)
    (defaults to: nil)
—    
    

    The max bson size of documents in the sections.
    

    
  
    • 
  
  • 
    validating_keys
    (true, false)
    (defaults to: nil)
—    
    

    Whether to validate document keys. This option is deprecated and will not be used. It will removed in version 3.0.
    

    
  
    • 



Returns:


    
  
  • 
    (BSON::ByteBuffer)
—    
    

    Buffer with serialized value.
    

    
  
    • 



Since:


    
  
  • 
    
    

    2.5.0
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongo/protocol/serializers.rb', line 192



def self.serialize(buffer, value, max_bson_size = nil, validating_keys = nil)
  value.each do |section|
    case section[:type]
    when PayloadZero::TYPE
      PayloadZero.serialize(buffer, section[:payload], max_bson_size)
    when nil
      PayloadZero.serialize(buffer, section[:payload], max_bson_size)
    when PayloadOne::TYPE
      PayloadOne.serialize(buffer, section[:payload], max_bson_size)
    else
      raise Error::UnknownPayloadType.new(section[:type])
    end
  end
end