Class: CZTop::Socket

Inherits:
Object
  • Object
show all
Extended by:
HasFFIDelegate::ClassMethods
Includes:
CZMQ::FFI, HasFFIDelegate, PolymorphicZsockMethods, SendReceiveMethods, ZsockOptions
Defined in:
lib/cztop/socket.rb,
lib/cztop/socket/types.rb

Overview

Represents a CZMQ::FFI::Zsock.

Direct Known Subclasses

CLIENT, DEALER, DISH, GATHER, PAIR, PUB, PULL, PUSH, RADIO, REP, REQ, ROUTER, SCATTER, SERVER, STREAM, SUB, XPUB, XSUB

Defined Under Namespace

Modules: Types Classes: CLIENT, DEALER, DISH, GATHER, PAIR, PUB, PULL, PUSH, RADIO, REP, REQ, ROUTER, SCATTER, SERVER, STREAM, SUB, XPUB, XSUB

Constant Summary collapse

TypeNames =

All the available type codes, mapped to their Symbol equivalent.

Returns:

  • (Hash<Integer, Symbol>) 
Types.constants.to_h do |name|
  i = Types.const_get(name)
  [i, name]
end.freeze

Constants included from SendReceiveMethods

CZTop::SendReceiveMethods::JIFFY

Instance Attribute Summary collapse

Attributes included from HasFFIDelegate

#ffi_delegate

CURVE Security collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from HasFFIDelegate::ClassMethods

ffi_delegate, from_ffi_delegate

Methods included from PolymorphicZsockMethods

#set_unbounded, #signal, #wait

Methods included from SendReceiveMethods

#<<, #read_timeout, #receive, #wait_readable, #wait_writable, #write_timeout

Methods included from ZsockOptions

#fd, #options, #readable?, #to_io, #writable?

Methods included from HasFFIDelegate

#attach_ffi_delegate, #from_ffi_delegate, raise_zmq_err, #to_ptr

Constructor Details

#initialize(endpoints = nil) ⇒ Socket

Returns a new instance of Socket.



65
 
# File 'lib/cztop/socket/types.rb', line 65

def initialize(endpoints = nil); end

Instance Attribute Details

#last_tcp_port ⇒ Integer? (readonly)

Returns:

  • (Integer) —

    last automatically selected, bound TCP port, if any

  • (nil) —

    if not bound to a TCP port yet



83
84
85
 
# File 'lib/cztop/socket.rb', line 83

def last_tcp_port
  @last_tcp_port
end

Class Method Details

.new_by_type(type) ⇒ REQ, ...

Returns the new socket.

Examples:

Creating a socket by providing its type as a parameter

my_sock = CZTop::Socket.new_by_type(:DEALER, "tcp://example.com:4000")

Parameters:

  • type (Symbol, Integer) —

    type from Types or like :PUB

Returns:

See Also:



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/cztop/socket/types.rb', line 45

def self.new_by_type(type)
  case type
  when Integer
    type_code  = type
    type_name  = TypeNames[type_code] or
      raise ArgumentError, format('invalid type %p', type)
    type_class = Socket.const_get(type_name)
  when Symbol
    type_code  = Types.const_get(type)
    type_class = Socket.const_get(type)
  else
    raise ArgumentError, format('invalid socket type: %p', type)
  end
  ffi_delegate = Zsock.new(type_code)
  sock         = type_class.allocate
  sock.attach_ffi_delegate(ffi_delegate)
  sock
end

Instance Method Details

#bind(endpoint) ⇒ void

Note:

When binding to an automatically selected TCP port, this will set #last_tcp_port.

This method returns an undefined value.

Binds to an endpoint.

Parameters:

  • endpoint (String)

Raises:

  • (SystemCallError) —

    in case of failure



91
92
93
94
95
 
# File 'lib/cztop/socket.rb', line 91

def bind(endpoint)
  rc = ffi_delegate.bind('%s', :string, endpoint)
  raise_zmq_err(format('unable to bind to %p', endpoint)) if rc == -1
  @last_tcp_port = rc if rc.positive?
end

#close ⇒ void

Note:

Don’t try to use it anymore afterwards.

This method returns an undefined value.

Closes and destroys the native socket.



77
78
79
 
# File 'lib/cztop/socket.rb', line 77

def close
  ffi_delegate.destroy
end

#connect(endpoint) ⇒ void

This method returns an undefined value.

Connects to an endpoint.

Parameters:

  • endpoint (String)

Raises:

  • (ArgumentError) —

    if the endpoint is incorrect



58
59
60
61
 
# File 'lib/cztop/socket.rb', line 58

def connect(endpoint)
  rc = ffi_delegate.connect('%s', :string, endpoint)
  raise ArgumentError, format('incorrect endpoint: %p', endpoint) if rc == -1
end

#CURVE_client!(client_cert, server_cert) ⇒ void

This method returns an undefined value.

Enables CURVE security and makes this socket a CURVE client.

Parameters:

  • client_cert (Certificate) —

    client’s certificate, to secure communication (and be authenticated by the server)

  • server_cert (Certificate) —

    the remote server’s certificate, so this socket is able to authenticate the server

Raises:

  • (SecurityError) —

    if the server’s secret key is set in server_cert, which means it’s not secret anymore

  • (SystemCallError) —

    if there’s no secret key in client_cert



37
38
39
40
41
42
 
# File 'lib/cztop/socket.rb', line 37

def CURVE_client!(client_cert, server_cert)
  raise SecurityError, "server's secret key not secret" if server_cert.secret_key

  client_cert.apply(self) # NOTE: desired: raises if no secret key in cert
  options.CURVE_serverkey = server_cert.public_key
end

#CURVE_server!(cert) ⇒ void

Note:

You’ll have to use a Authenticator.

This method returns an undefined value.

Enables CURVE security and makes this socket a CURVE server.

Parameters:

  • cert (Certificate) —

    this server’s certificate, so remote clients are able to authenticate this server

Raises:

  • (ArgumentError) —

    if there’s no secret key in certificate



22
23
24
25
 
# File 'lib/cztop/socket.rb', line 22

def CURVE_server!(cert)
  options.CURVE_server = true
  cert.apply(self) # NOTE: desired: raises if no secret key in cert
end

#disconnect(endpoint) ⇒ void

This method returns an undefined value.

Disconnects from an endpoint.

Parameters:

  • endpoint (String)

Raises:

  • (ArgumentError) —

    if the endpoint is incorrect



68
69
70
71
 
# File 'lib/cztop/socket.rb', line 68

def disconnect(endpoint)
  rc = ffi_delegate.disconnect('%s', :string, endpoint)
  raise ArgumentError, format('incorrect endpoint: %p', endpoint) if rc == -1
end

#inspect ⇒ String

Inspects this CZTop::Socket.

Returns:



110
111
112
113
114
 
# File 'lib/cztop/socket.rb', line 110

def inspect
  format('#<%s:0x%x last_endpoint=%p>', self.class, to_ptr.address, last_endpoint)
rescue Zsock::DestroyedError
  format('#<%s: invalid>', self.class)
end

#last_endpoint ⇒ String?

Returns:

  • (String) —

    last bound endpoint, if any

  • (nil) —

    if not bound



49
50
51
 
# File 'lib/cztop/socket.rb', line 49

def last_endpoint
  ffi_delegate.endpoint
end

#unbind(endpoint) ⇒ void

This method returns an undefined value.

Unbinds from an endpoint.

Parameters:

  • endpoint (String)

Raises:

  • (ArgumentError) —

    if the endpoint is incorrect



102
103
104
105
 
# File 'lib/cztop/socket.rb', line 102

def unbind(endpoint)
  rc = ffi_delegate.unbind('%s', :string, endpoint)
  raise ArgumentError, format('incorrect endpoint: %p', endpoint) if rc == -1
end