class NNTP::Connection

• NNTP::Connection
• Reference
• Object

Included Modules

• NNTP::Connection::Articles
• NNTP::Connection::Context
• NNTP::Connection::Groups
• NNTP::Connection::Pool
• NNTP::Connection::Search

Defined in:

Constant Summary

Log = ::Log.for(self)

Constructors

• .connect(host, port = 119, use_ssl = true, verify_mode : OpenSSL::SSL::VerifyMode = OpenSSL::SSL::VerifyMode::PEER, open_timeout : Int32 = 30, read_timeout : Int32 = 60, user : String | Nil = nil, secret : String | Nil = nil, method = :original) : Connection

  Will initialize a new Connection object, configure it, then establish a connection.

• .new(uri : URI)

  nntp://user:[email protected]:443/?ssl=true&verify_mode=none&method=original

• .new(host, port = 119, use_ssl = true, verify_mode : String = "peer", open_timeout : Int32 = 30, read_timeout : Int32 = 60) : Connection
• .new

Class Method Summary

• .connect(uri : URI)

Instance Method Summary

• #close
• #configure(&)

  Will yield self to provided block allow for variable setting.

• #connect(user : String | Nil = nil, secret : String | Nil = nil, method = :original)

  Will establish a NNTP::Socket connection using client setting and any authentication params passed.

• #connect(uri : URI)
• #connected?

  Returns true if a connection has been established and false if not.

• #host : String
• #host=(host : String)
• #open_timeout : Int32
• #open_timeout=(open_timeout : Int32)
• #port : Int32
• #port=(port : Int32)
• #read_timeout : Int32
• #read_timeout=(read_timeout : Int32)
• #use_ssl : Bool
• #use_ssl=(use_ssl : Bool)
• #verify_mode : OpenSSL::SSL::VerifyMode
• #verify_mode=(verify_mode : OpenSSL::SSL::VerifyMode)
• #with_socket(&)

Constructor Detail

client = NNTP::Connection.connect("localhost", user: "myuser", pass: "mypass")
client.connected? # => true

Class Method Detail

Instance Method Detail

client = NNTP::Connection.new
client.configure do |c|
  c.host = host
  c.port = port
  c.use_ssl = use_ssl
  c.open_timeout = open_timeout
  c.read_timeout = read_timeout
end

client = NNTP::Connection.new
client.connect("MyUSER", "SuperSecret")

client = NNTP::Connection.new
client.connected? # => false
client.connect
client.connected? # => true