RubyDNS

Copyright, 2009, 2012, by Samuel G. D. Williams. <www.codeotaku.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


Copyright, 2009, 2012, by Samuel G. D. Williams. <www.codeotaku.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


Copyright, 2009, 2012, by Samuel G. D. Williams. <www.codeotaku.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Constants

DecodeError
Message

The DNS message container.

UDP_TRUNCATION_SIZE
VERSION

Public Class Methods

chunked(string, chunk_size = 255) click to toggle source

Produces an array of arrays of binary data with each sub-array a maximum of chunk_size bytes.

# File lib/rubydns/chunked.rb, line 23
def self.chunked(string, chunk_size = 255)
        chunks = []
        
        offset = 0
        while offset < string.bytesize
                chunks << string.byteslice(offset, chunk_size)
                offset += chunk_size
        end
        
        return chunks
end
decode_message(data) click to toggle source

Decodes binary data into a {Message}.

# File lib/rubydns/message.rb, line 51
def self.decode_message(data)
        # Otherwise the decode process might fail with non-binary data.
        if data.respond_to? :force_encoding
                data.force_encoding("BINARY")
        end
        
        begin
                return Message.decode(data)
        rescue DecodeError
                raise
        rescue StandardError => error
                new_error = DecodeError.new(error.message)
                new_error.set_backtrace(error.backtrace)
                
                raise new_error
        end
        
rescue => error
        # Log the bad messsage if required:
        if @dump_bad_message
                @dump_bad_message.call(error, data)
        end
        
        raise
end
get_peer_details(connection) click to toggle source

@returns the [port, ip address] of the given connection.

# File lib/rubydns/handler.rb, line 26
def self.get_peer_details(connection)
        Socket.unpack_sockaddr_in(connection.get_peername)
end
log_bad_messages!(log_path) click to toggle source

Call this function with a path where bad messages will be saved. Any message that causes an exception to be thrown while decoding the binary will be saved in base64 for later inspection. The log file could grow quickly so be careful - not designed for long term use.

# File lib/rubydns/message.rb, line 40
def self.log_bad_messages!(log_path)
        bad_messages_log = Logger.new(log_path, 10, 1024*100)
        bad_messages_log.level = Logger::DEBUG
        
        @dump_bad_message = lambda do |error, data|
                bad_messages_log.debug("Bad message: #{Base64.encode64(data)}")
                RubyDNS.log_exception(bad_messages_log, error)
        end
end
log_exception(logger, exception) click to toggle source

Logs an exception nicely to a standard `Logger`.

# File lib/rubydns/extensions/logger.rb, line 23
def self.log_exception(logger, exception)
        logger.error "#{exception.class}: #{exception.message}"
        if exception.backtrace
                Array(exception.backtrace).each { |at| logger.error at }
        end
        
end
run_server(options = {}, &block) click to toggle source

Run a server with the given rules.

# File lib/rubydns.rb, line 38
def self.run_server (options = {}, &block)
        server = RubyDNS::RuleBasedServer.new(&block)
        
        EventMachine.run do
                server.run(options)
        end
        
        server.fire(:stop)
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.