class

NNTP::Connection

Inherits NNTP::Connection::Pool < NNTP::Connection::Search < NNTP::Connection::Groups < NNTP::Connection::Context < NNTP::Connection::Articles < Reference < Object

Constants

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. The created Connection will then be returned.

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

new(uri : URI)

nntp://user:password@usenethost.com: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 methods

connect(uri : URI)

Instance methods

close

configure

Will yield self to provided block allow for variable setting. Then create a new NNTP::Socket instance (without connecting) Will return self.

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

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.

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

connect(uri : URI)

connected?

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

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

host

host=(host : String)

open_timeout

open_timeout=(open_timeout : Int32)

port

port=(port : Int32)

read_timeout

read_timeout=(read_timeout : Int32)

use_ssl

use_ssl=(use_ssl : Bool)

verify_mode

verify_mode=(verify_mode : OpenSSL::SSL::VerifyMode)

with_socket

Nested types