zmq Module Functions

Functions
hash< Qore::ZMQ::ZmqCurveKeyInfo >	Qore::ZMQ::zmq_curve_keypair ()
	generates a random secret and public key for Curve and returns this information in a hash
string	Qore::ZMQ::zmq_curve_public (string secret)
	generate a Curve public key from a secret/private key
hash< Qore::ZMQ::ZmqVersionInfo >	Qore::ZMQ::zmq_version ()
	returns a hash of ZeroMQ library information
string	Qore::ZMQ::zmq_z85_encode (binary data)
	returns a string in Z85 printable format corresponding to the given binary value with a length divisible by 4

Detailed Description

Function Documentation

zmq_curve_keypair()

hash< Qore::ZMQ::ZmqCurveKeyInfo > Qore::ZMQ::zmq_curve_keypair

(

)

generates a random secret and public key for Curve and returns this information in a hash

Code Flags:

RET_VALUE_ONLY

Example:

hash<ZmqCurveKeyInfo> kh = zmq_curve_keypair();

Returns

a ZmqCurveKeyInfo hash for a randomly-generated secret and public key for Curve

Exceptions

ZMQ-CURVE-KEYPAIR-ERROR

an error was generated calling zmq_curve_keypair()

zmq_curve_public()

string Qore::ZMQ::zmq_curve_public

(

string

secret

)

generate a Curve public key from a secret/private key

Code Flags:

RET_VALUE_ONLY

Example:

string public = zmq_curve_public(priv);

Parameters

secret

a 40-byte Curve secret/private key in Z85 printable format

Returns

a Curve public key in Z85 printable format from the given secret key

Exceptions

ZMQ-CURVE-PUBLIC-ERROR

an error was generated calling zmq_curve_public()

zmq_version()

hash< Qore::ZMQ::ZmqVersionInfo > Qore::ZMQ::zmq_version

(

)

returns a hash of ZeroMQ library information

Code Flags:

CONSTANT

Example:

hash h = zmq_version();

Returns

a ZmqVersionInfo hash of ZeroMQ library information

zmq_z85_encode()

string Qore::ZMQ::zmq_z85_encode

(

binary

data

)

returns a string in Z85 printable format corresponding to the given binary value with a length divisible by 4

Code Flags:

RET_VALUE_ONLY

Example:

string z85str = zmq_z85_encode(bin);

Parameters

data	a binary value with a length divisible by 4

Returns

a string in Z85 printable format corresponding to the argument

Exceptions

ZMQ-Z85-ENCODE-ERROR

an error was generated calling zmq_z85_encode()

Note

Curve keys should be 32 bytes long