pj_ssl_sock_param class final

Definition of secure socket creation parameters.

Inheritance
Implemented types
Available extensions

Constructors

pj_ssl_sock_param()

Properties

address → Pointer<T>

Available on T, provided by the StructAddress extension

The memory address of the underlying data.
no setter
async_cnt ↔ int
Number of concurrent asynchronous operations that is to be supported by the secure socket. This value only affects socket receive and accept operations -- the secure socket will issue one or more asynchronous read and accept operations based on the value of this field. Setting this field to more than one will allow more than one incoming data or incoming connections to be processed simultaneously on multiprocessor systems, when the ioqueue is polled by more than one threads.
getter/setter pair
cb ↔ pj_ssl_sock_cb
Specify secure socket callbacks, see #pj_ssl_sock_cb.
getter/setter pair
ciphers ↔ Pointer<Int32>
Ciphers and order preference. If empty, then default cipher list and its default order of the backend will be used.
getter/setter pair
ciphers_num ↔ int
Number of ciphers contained in the specified cipher preference. If this is set to zero, then the cipher list used will be determined by the backend default (for OpenSSL backend, setting PJ_SSL_SOCK_OSSL_CIPHERS will be used).
getter/setter pair
concurrency ↔ int
The ioqueue concurrency to be forced on the socket when it is registered to the ioqueue. See #pj_ioqueue_set_concurrency() for more info about ioqueue concurrency.
getter/setter pair
curves ↔ Pointer<Int32>
Curves and order preference. The #pj_ssl_curve_get_availables() can be used to check the available curves supported by backend.
getter/setter pair
curves_num ↔ int
Number of curves contained in the specified curve preference. If this is set to zero, then default curve list of the backend will be used.
getter/setter pair
enable_renegotiation ↔ int
Specify if renegotiation is enabled for TLSv1.2 or earlier.
getter/setter pair
entropy_path ↔ pj_str_t
When using a file/socket for entropy #PJ_SSL_ENTROPY_EGD or #PJ_SSL_ENTROPY_FILE, \a entropy_path must contain the path to entropy socket/file.
getter/setter pair
entropy_type ↔ int
Reseed random number generator. For type #PJ_SSL_ENTROPY_FILE, parameter \a entropy_path must be set to a file. For type #PJ_SSL_ENTROPY_EGD, parameter \a entropy_path must be set to a socket.
getter/setter pair
grp_lock ↔ Pointer<pj_grp_lock_t>
Optional group lock to be assigned to the ioqueue key.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
ioqueue ↔ Pointer<pj_ioqueue_t>
Specify the ioqueue to use. Secure socket uses the ioqueue to perform active socket operations, see \ref PJ_ACTIVESOCK for more detail.
getter/setter pair
proto ↔ int
Specify security protocol to use, see #pj_ssl_sock_proto. Use bitwise OR operation to combine the protocol type.
getter/setter pair
qos_ignore_error ↔ int
Specify if the transport should ignore any errors when setting the QoS traffic type/parameters.
getter/setter pair
qos_params ↔ pj_qos_params
Set the low level QoS parameters to the transport. This is a lower level operation than setting the \a qos_type field and may not be supported on all platforms.
getter/setter pair
qos_type ↔ int
QoS traffic type to be set on this transport. When application wants to apply QoS tagging to the transport, it's preferable to set this field rather than \a qos_param fields since this is more portable.
getter/setter pair
read_buffer_size ↔ int
Specify buffer size for receiving encrypted (and perhaps compressed) data on underlying socket. This setting is unused on Symbian, since SSL/TLS Symbian backend, CSecureSocket, can use application buffer directly.
getter/setter pair
require_client_cert ↔ int
When secure socket is acting as server (handles incoming connection), it will require the client to provide certificate.
getter/setter pair
reuse_addr ↔ int
Specify if SO_REUSEADDR should be used for listening socket. This option will only be used with accept() operation.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
send_buffer_size ↔ int
Specify buffer size for sending operation. Buffering sending data is used for allowing application to perform multiple outstanding send operations. Whenever application specifies this setting too small, sending operation may return PJ_ENOMEM.
getter/setter pair
server_name ↔ pj_str_t
Server name indication. When secure socket is acting as client (perform outgoing connection) and the server may host multiple 'virtual' servers at a single underlying network address, setting this will allow client to tell the server a name of the server it is contacting. This must be set to hostname and literal IP addresses are not allowed.
getter/setter pair
sigalgs ↔ pj_str_t
The supported signature algorithms. Set the sigalgs string using this form: "
getter/setter pair
sock_af ↔ int
Specifies socket address family, either pj_AF_INET() and pj_AF_INET6().
getter/setter pair
sock_cloexec ↔ int
Specify if should set close-on-exec flag for socket.
getter/setter pair
sock_type ↔ int
Specify socket type, either pj_SOCK_DGRAM() or pj_SOCK_STREAM().
getter/setter pair
sockopt_ignore_error ↔ int
Specify if the transport should ignore any errors when setting the sockopt parameters.
getter/setter pair
sockopt_params ↔ pj_sockopt_params
Specify options to be set on the transport.
getter/setter pair
timeout ↔ pj_time_val
Security negotiation timeout. If this is set to zero (both sec and msec), the negotiation doesn't have a timeout.
getter/setter pair
timer_heap ↔ Pointer<pj_timer_heap_t>
Specify the timer heap to use. Secure socket uses the timer to provide auto cancelation on asynchronous operation when it takes longer time than specified timeout period, e.g: security negotiation timeout.
getter/setter pair
user_data ↔ Pointer<Void>
Specify secure socket user data.
getter/setter pair
verify_peer ↔ int
Specify whether endpoint should verify peer certificate.
getter/setter pair
whole_data ↔ int
If this option is specified, the secure socket will make sure that asynchronous send operation with stream oriented socket will only call the callback after all data has been sent. This means that the secure socket will automatically resend the remaining data until all data has been sent.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited