Contents

# frozen_string_literal: true

module RubyClamdscan
  # Configuration for the gem
  class Configuration
    # TCP Port ClamAV is listening on if using TCP
    # Default: 3310
    # @return [Integer]
    attr_accessor :tcp_port

    # Host ClamAV is listening on if using TCP
    # Default: localhost
    # @return [String]
    attr_accessor :tcp_host

    # Unix Socket for ClamAV
    # Default: /tmp/clamd.socket
    # @return [String]
    attr_accessor :unix_socket

    # Chunk size in bytes for streaming files
    # Default: 1024
    # @return [Integer]
    attr_accessor :chunk_size

    # If TCP socket should be used. If false, the Unix socket will be used instead
    # Note, if running ClamAV on the same host, it is recommended to use the Unix socket as it's much faster
    # Default: false
    # @return [Boolean]
    attr_accessor :use_tcp_socket

    # If the server responds with an empty string, raise an error instead of just returning the empty string
    # Default: true
    # @return [Boolean]
    attr_accessor :raise_error_on_empty_response

    # If a virus is detected in the scanned contents, raise an error
    # RubyClamdscan::Commands::Scan methods will raise RubyClamdscan::Errors::VirusDetected
    # Default: true
    # @return [Boolean]
    attr_accessor :raise_error_on_virus_detected

    def initialize
      @use_tcp_socket = false
      @tcp_host = "localhost"
      @tcp_port = 3310
      @chunk_size = 1024
      @unix_socket = "/tmp/clamd.socket"
      @raise_error_on_empty_response = true
      @raise_error_on_virus_detected = true
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
ruby_clamdscan-0.1.3	lib/ruby_clamdscan/configuration.rb