pjsip_tls_setting class final

TLS transport settings.

Inheritance
Implemented types
Available extensions

Constructors

pjsip_tls_setting()

Properties

address → Pointer<T>

Available on T, provided by the StructAddress extension

The memory address of the underlying data.
no setter
ca_buf ↔ pj_ssl_cert_buffer
Certificate of Authority (CA) buffer. If ca_list_file, ca_list_path, cert_file or privkey_file are set, this setting will be ignored.
getter/setter pair
ca_list_file ↔ pj_str_t
Certificate of Authority (CA) list file.
getter/setter pair
ca_list_path ↔ pj_str_t
Certificate of Authority (CA) list directory path.
getter/setter pair
cert_buf ↔ pj_ssl_cert_buffer
Public endpoint certificate buffer, which will be used as client- side certificate for outgoing TLS connection, and server-side certificate for incoming TLS connection. If ca_list_file, ca_list_path, cert_file or privkey_file are set, this setting will be ignored.
getter/setter pair
cert_file ↔ pj_str_t
Public endpoint certificate file, which will be used as client- side certificate for outgoing TLS connection, and server-side certificate for incoming TLS connection.
getter/setter pair
ciphers ↔ Pointer<Int32>
Ciphers and order preference. The #pj_ssl_cipher_get_availables() can be used to check the available ciphers supported by backend.
getter/setter pair
ciphers_num ↔ int
Number of ciphers contained in the specified cipher preference. If this is set to zero, then default cipher list of the backend will be used.
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
hashCode → int
The hash code for this object.
no setterinherited
initial_timeout ↔ int
Intial timeout interval to be applied to incoming transports (i.e. server side) when no valid data received after a successful connection.
getter/setter pair
method ↔ int
TLS protocol method from #pjsip_ssl_method. In the future, this field might be deprecated in favor of proto field. For now, this field is only applicable only when proto field is set to zero.
getter/setter pair
on_accept_fail_cb ↔ Pointer<NativeFunction<Void Function(Pointer<pjsip_tls_on_accept_fail_param> param)>>
Callback to be called when a accept operation of the TLS listener fails.
getter/setter pair
on_verify_cb ↔ Pointer<NativeFunction<pj_bool_t Function(Pointer<pjsip_tls_on_verify_param> param)>>
Callback to be called to verify a new connection. Currently it's only implemented for OpenSSL backend.
getter/setter pair
password ↔ pj_str_t
Password to open private key.
getter/setter pair
privkey_buf ↔ pj_ssl_cert_buffer
Optional private key buffer of the endpoint certificate to be used. If ca_list_file, ca_list_path, cert_file or privkey_file are set, this setting will be ignored.
getter/setter pair
privkey_file ↔ pj_str_t
Optional private key of the endpoint certificate to be used.
getter/setter pair
proto ↔ int
TLS protocol type from #pj_ssl_sock_proto. Use this field to enable specific protocol type. 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
require_client_cert ↔ int
When acting as server (incoming TLS connections), reject inocming connection if client doesn't supply a TLS certificate.
getter/setter pair
reuse_addr ↔ int
Should SO_REUSEADDR be used for the listener socket. Default value is PJSIP_TLS_TRANSPORT_REUSEADDR.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sigalgs ↔ pj_str_t
The supported signature algorithms. Set the sigalgs string using this form: "
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
TLS negotiation timeout to be applied for both outgoing and incoming connection. If both sec and msec member is set to zero, the SSL negotiation doesn't have a timeout.
getter/setter pair
verify_client ↔ int
Specifies TLS transport behavior on the client TLS certificate verification result:
getter/setter pair
verify_server ↔ int
Specifies TLS transport behavior on the server TLS certificate verification result:
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