~~Title: Efl.Net.Dialer_Ssl~~ ====== Efl.Net.Dialer_Ssl (class) ====== ===== Description ===== %%Connects to a remote SSL server using TCP.%% %%This creates an internal %%[[:develop:api:efl:net:dialer_tcp|Efl.Net.Dialer_Tcp]]%% and once connected it will start the SSL handshake.%% %%If the proxy is %%''NULL''%% (default), then the system proxy will be used. On UNIX that's the environment variable %%''socks_proxy''%% (or '%%''proxy''%%' or '%%''all_proxy''%%') is used if the given address doesn't match %%''no_proxy''%% patterns. To disable proxy use an empty string.%% %%If the proxy is %%''NULL''%% (default), then the system proxy will be used. On UNIX that's the environment variable %%''socks_proxy''%% (or '%%''all_proxy''%%') is used if the given address doesn't match %%''no_proxy''%% patterns. To disable proxy use an empty string. If provided proxy must be one of the protocols:%% %%- socks5://username:password@proxyserver:port (SOCKSv5) - socks5h://username@proxyserver:port (let socks server to resolve domain) - socks5://proxyserver:port - socks5://proxyserver (default port 1080) - socks4a://proxyserver:port (SOCKSv4 and let socks server to resolve domain) - socks4://proxyserver:port (SOCKSv4)%% {{page>:develop:api-include:efl:net:dialer_ssl:description&nouser&nolink&nodate}} ===== Inheritance ===== => [[:develop:api:efl:net:socket_ssl|Efl.Net.Socket_Ssl]] //(class)// => [[:develop:api:efl:loop_consumer|Efl.Loop_Consumer]] //(class)// => [[:develop:api:efl:object|Efl.Object]] //(class)// ++++ Full hierarchy | * [[:develop:api:efl:net:socket_ssl|Efl.Net.Socket_Ssl]] //(class)// * [[:develop:api:efl:loop_consumer|Efl.Loop_Consumer]] //(class)// * [[:develop:api:efl:object|Efl.Object]] //(class)// * [[:develop:api:efl:net:socket|Efl.Net.Socket]] //(interface)// * [[:develop:api:efl:io:reader|Efl.Io.Reader]] //(interface)// * [[:develop:api:efl:io:writer|Efl.Io.Writer]] //(interface)// * [[:develop:api:efl:io:closer|Efl.Io.Closer]] //(interface)// * [[:develop:api:efl:net:dialer|Efl.Net.Dialer]] //(interface)// * [[:develop:api:efl:net:socket|Efl.Net.Socket]] //(interface)// * [[:develop:api:efl:io:reader|Efl.Io.Reader]] //(interface)// * [[:develop:api:efl:io:writer|Efl.Io.Writer]] //(interface)// * [[:develop:api:efl:io:closer|Efl.Io.Closer]] //(interface)// ++++ ===== Members ===== **[[:develop:api:efl:net:dialer_ssl:property:address_dial|address_dial]]** //**(get, set)**// ''protected set''// [Overridden from [[:develop:api:efl:net:dialer|Efl.Net.Dialer]]]//\\ > %%Returns the address given to %%[[:develop:api:efl:net:dialer:method:dial|Efl.Net.Dialer.dial]]%%.%% const char *efl_net_dialer_address_dial_get(const Eo *obj); void efl_net_dialer_address_dial_set(Eo *obj, const char *address); \\ **[[:develop:api:efl:net:dialer_ssl:method:close|close]]**// [Overridden from [[:develop:api:efl:io:closer|Efl.Io.Closer]]]//\\ > %%Closes the Input/Output object.%% Eina_Error efl_io_closer_close(Eo *obj); \\ **[[:develop:api:efl:net:dialer_ssl:property:connected|connected]]** //**(get, set)**// ''protected set''// [Overridden from [[:develop:api:efl:net:dialer|Efl.Net.Dialer]]]//\\ > %%Returns whenever the socket is connected or not.%% Eina_Bool efl_net_dialer_connected_get(const Eo *obj); void efl_net_dialer_connected_set(Eo *obj, Eina_Bool connected); \\ **[[:develop:api:efl:net:dialer_ssl:method:constructor|constructor]]**// [Overridden from [[:develop:api:efl:object|Efl.Object]]]//\\ > %%Implement this method to provide optional initialization code for your object.%% Efl_Object *efl_constructor(Eo *obj); \\ **[[:develop:api:efl:net:dialer_ssl:method:dial|dial]]**// [Overridden from [[:develop:api:efl:net:dialer|Efl.Net.Dialer]]]//\\ > %%Dials to the remote peer.%% Eina_Error efl_net_dialer_dial(Eo *obj, const char *address); \\ **[[:develop:api:efl:net:dialer_ssl:method:finalize|finalize]]**// [Overridden from [[:develop:api:efl:object|Efl.Object]]]//\\ > %%Implement this method to finish the initialization of your object after all (if any) user-provided configuration methods have been executed.%% Efl_Object *efl_finalize(Eo *obj); \\ **[[:develop:api:efl:net:dialer_ssl:method:invalidate|invalidate]]**// [Overridden from [[:develop:api:efl:object|Efl.Object]]]//\\ > %%Implement this method to perform special actions when your object loses its parent, if you need to.%% void efl_invalidate(Eo *obj); \\ **[[:develop:api:efl:net:dialer_ssl:property:keep_alive|keep_alive]]** //**(get, set)**//\\ > %%Controls keep-alive using SO_KEEPALIVE%% Eina_Bool efl_net_dialer_ssl_keep_alive_get(const Eo *obj); Eina_Bool efl_net_dialer_ssl_keep_alive_set(Eo *obj, Eina_Bool keep_alive); \\ **[[:develop:api:efl:net:dialer_ssl:property:no_delay|no_delay]]** //**(get, set)**//\\ > %%Controls TCP's no-delay using TCP_NODELAY%% Eina_Bool efl_net_dialer_ssl_no_delay_get(const Eo *obj); Eina_Bool efl_net_dialer_ssl_no_delay_set(Eo *obj, Eina_Bool no_delay); \\ **[[:develop:api:efl:net:dialer_ssl:property:proxy|proxy]]** //**(get, set)**//// [Overridden from [[:develop:api:efl:net:dialer|Efl.Net.Dialer]]]//\\ > %%Controls/retrieves if the dialer should use a proxy.%% const char *efl_net_dialer_proxy_get(const Eo *obj); void efl_net_dialer_proxy_set(Eo *obj, const char *proxy_url); \\ **[[:develop:api:efl:net:dialer_ssl:property:ssl_context|ssl_context]]** //**(get, set)**//\\ > %%Defines the SSL context to use for this dialer.%% Efl_Net_Ssl_Context *efl_net_dialer_ssl_context_get(const Eo *obj); void efl_net_dialer_ssl_context_set(Eo *obj, Efl_Net_Ssl_Context *ssl_context); \\ **[[:develop:api:efl:net:dialer_ssl:property:timeout_dial|timeout_dial]]** //**(get, set)**//// [Overridden from [[:develop:api:efl:net:dialer|Efl.Net.Dialer]]]//\\ > %%The timeout in seconds to use for dialing/connecting.%% double efl_net_dialer_timeout_dial_get(const Eo *obj); void efl_net_dialer_timeout_dial_set(Eo *obj, double seconds); \\ ==== Inherited ==== ^ [[:develop:api:efl:loop_consumer|Efl.Loop_Consumer]] ^^^ | | **[[:develop:api:efl:loop_consumer:method:future_rejected|future_rejected]]** | %%Creates a new future that is already rejected to a specified error using the %%[[:develop:api:efl:loop_consumer:property:loop|Efl.Loop_Consumer.loop.get]]%%.%% | | | **[[:develop:api:efl:loop_consumer:method:future_resolved|future_resolved]]** | %%Creates a new future that is already resolved to a value.%% | | | **[[:develop:api:efl:loop_consumer:property:loop|loop]]** //**(get)**// | | | | **[[:develop:api:efl:loop_consumer:property:parent|parent]]** //**(get, set)**// | %%The parent of an object.%% | | | **[[:develop:api:efl:loop_consumer:method:promise_new|promise_new]]** | %%Create a new promise with the scheduler coming from the loop provided by this object.%% | ^ [[:develop:api:efl:net:socket_ssl|Efl.Net.Socket_Ssl]] ^^^ | ''protected set'' | **[[:develop:api:efl:net:socket_ssl:property:address_local|address_local]]** //**(get, set)**// | %%The local address, similar to getsockname().%% | | ''protected set'' | **[[:develop:api:efl:net:socket_ssl:property:address_remote|address_remote]]** //**(get, set)**// | %%The remote address, similar to getpeername().%% | | | **[[:develop:api:efl:net:socket_ssl:method:adopt|adopt]]** | %%Adopt an Efl.Net.Dialer or regular Efl.Net.Socket that will be used for the actual communication.%% | | ''protected set'' | **[[:develop:api:efl:net:socket_ssl:property:can_read|can_read]]** //**(get, set)**// | %%If %%''true''%% will notify %%[[:develop:api:efl:io:reader:method:read|Efl.Io.Reader.read]]%% can be called without blocking or failing.%% | | ''protected set'' | **[[:develop:api:efl:net:socket_ssl:property:can_write|can_write]]** //**(get, set)**// | %%If %%''true''%% will notify %%[[:develop:api:efl:io:writer:method:write|Efl.Io.Writer.write]]%% can be called without blocking or failing.%% | | | **[[:develop:api:efl:net:socket_ssl:property:close_on_exec|close_on_exec]]** //**(get, set)**// | %%If true will automatically close resources on exec() calls.%% | | | **[[:develop:api:efl:net:socket_ssl:property:close_on_invalidate|close_on_invalidate]]** //**(get, set)**// | %%If true will automatically close() on object invalidate.%% | | | **[[:develop:api:efl:net:socket_ssl:property:closed|closed]]** //**(get)**// | | | | **[[:develop:api:efl:net:socket_ssl:method:destructor|destructor]]** | %%Implement this method to provide deinitialization code for your object if you need it.%% | | ''protected set'' | **[[:develop:api:efl:net:socket_ssl:property:eos|eos]]** //**(get, set)**// | %%If %%''true''%% will notify end of stream.%% | | | **[[:develop:api:efl:net:socket_ssl:property:hostname_override|hostname_override]]** //**(get, set)**// | %%Overrides the hostname to use for this socket.%% | | | **[[:develop:api:efl:net:socket_ssl:property:hostname_verify|hostname_verify]]** //**(get, set)**// | %%Define if hostname should be verified.%% | | | **[[:develop:api:efl:net:socket_ssl:method:read|read]]** | %%Reads data into a pre-allocated buffer.%% | | | **[[:develop:api:efl:net:socket_ssl:property:verify_mode|verify_mode]]** //**(get, set)**// | %%How to verify the remote peer.%% | | | **[[:develop:api:efl:net:socket_ssl:method:write|write]]** | %%Writes data from a pre-populated buffer.%% | | ''protected'' | **[[:develop:api:efl:net:socket_ssl:property:adopted|adopted]]** //**(get)**// | | ^ [[:develop:api:efl:object|Efl.Object]] ^^^ | | **[[:develop:api:efl:object:property:allow_parent_unref|allow_parent_unref]]** //**(get, set)**// | %%Allow an object to be deleted by unref even if it has a parent.%% | | | **[[:develop:api:efl:object:method:children_iterator_new|children_iterator_new]]** | %%Get an iterator on all children.%% | | | **[[:develop:api:efl:object:property:comment|comment]]** //**(get, set)**// | %%A human readable comment for the object.%% | | | **[[:develop:api:efl:object:method:composite_attach|composite_attach]]** | %%Make an object a composite object of another.%% | | | **[[:develop:api:efl:object:method:composite_detach|composite_detach]]** | %%Detach a composite object from another object.%% | | | **[[:develop:api:efl:object:method:composite_part_is|composite_part_is]]** | %%Check if an object is part of a composite object.%% | | | **[[:develop:api:efl:object:method:debug_name_override|debug_name_override]]** | %%Build a read-only name for this object used for debugging.%% | | | **[[:develop:api:efl:object:method:event_callback_forwarder_del|event_callback_forwarder_del]]** | %%Remove an event callback forwarder for a specified event and object.%% | | | **[[:develop:api:efl:object:method:event_callback_forwarder_priority_add|event_callback_forwarder_priority_add]]** | %%Add an event callback forwarder that will make this object emit an event whenever another object (%%''source''%%) emits it. The event is said to be forwarded from %%''source''%% to this object.%% | | | **[[:develop:api:efl:object:method:event_callback_stop|event_callback_stop]]** | %%Stop the current callback call.%% | | | **[[:develop:api:efl:object:method:event_freeze|event_freeze]]** | %%Freeze events of this object.%% | | | **[[:develop:api:efl:object:property:event_freeze_count|event_freeze_count]]** //**(get)**// | | | ''static'' | **[[:develop:api:efl:object:method:event_global_freeze|event_global_freeze]]** | %%Globally freeze events for ALL EFL OBJECTS.%% | | ''static'' | **[[:develop:api:efl:object:property:event_global_freeze_count|event_global_freeze_count]]** //**(get)**// | | | ''static'' | **[[:develop:api:efl:object:method:event_global_thaw|event_global_thaw]]** | %%Globally thaw events for ALL EFL OBJECTS.%% | | | **[[:develop:api:efl:object:method:event_thaw|event_thaw]]** | %%Thaw events of object.%% | | | **[[:develop:api:efl:object:property:finalized|finalized]]** //**(get)**// | | | | **[[:develop:api:efl:object:property:invalidated|invalidated]]** //**(get)**// | | | | **[[:develop:api:efl:object:property:invalidating|invalidating]]** //**(get)**// | | | | **[[:develop:api:efl:object:property:name|name]]** //**(get, set)**// | %%The name of the object.%% | | | **[[:develop:api:efl:object:method:name_find|name_find]]** | %%Find a child object with the given name and return it.%% | | | **[[:develop:api:efl:object:method:provider_find|provider_find]]** | %%Searches upwards in the object tree for a provider which knows the given class/interface.%% | | | **[[:develop:api:efl:object:method:provider_register|provider_register]]** | %%Will register a manager of a specific class to be answered by %%[[:develop:api:efl:object:method:provider_find|Efl.Object.provider_find]]%%.%% | | | **[[:develop:api:efl:object:method:provider_unregister|provider_unregister]]** | %%Will unregister a manager of a specific class that was previously registered and answered by %%[[:develop:api:efl:object:method:provider_find|Efl.Object.provider_find]]%%.%% | ===== Events ===== ==== Inherited ==== ^ [[:develop:api:efl:io:closer|Efl.Io.Closer]] ^^^ | | **[[:develop:api:efl:io:closer:event:closed|closed]]** | %%Notifies closed, when property is marked as true%% | ^ [[:develop:api:efl:io:reader|Efl.Io.Reader]] ^^^ | | **[[:develop:api:efl:io:reader:event:can_read_changed|can_read,changed]]** | %%Notifies can_read property changed.%% | | | **[[:develop:api:efl:io:reader:event:eos|eos]]** | %%Notifies end of stream, when property is marked as true.%% | ^ [[:develop:api:efl:io:writer|Efl.Io.Writer]] ^^^ | | **[[:develop:api:efl:io:writer:event:can_write_changed|can_write,changed]]** | %%Notifies can_write property changed.%% | ^ [[:develop:api:efl:net:dialer|Efl.Net.Dialer]] ^^^ | | **[[:develop:api:efl:net:dialer:event:dialer_connected|dialer,connected]]** | %%Notifies the socket is connected to the remote peer.%% | | | **[[:develop:api:efl:net:dialer:event:dialer_error|dialer,error]]** | %%Some error happened and the socket stopped working.%% | | | **[[:develop:api:efl:net:dialer:event:dialer_resolved|dialer,resolved]]** | %%Notifies %%[[:develop:api:efl:net:dialer:property:address_dial|Efl.Net.Dialer.address_dial]]%% was resolved to %%[[:develop:api:efl:net:socket:property:address_remote|Efl.Net.Socket.address_remote]]%%.%% | ^ [[:develop:api:efl:net:socket_ssl|Efl.Net.Socket_Ssl]] ^^^ | | **[[:develop:api:efl:net:socket_ssl:event:ssl_error|ssl,error]]** | %%An error such as %%[[:develop:api:efl:net:socket_ssl_error:handshake|Efl.Net.Socket_Ssl_Error.HANDSHAKE]]%%%% | | | **[[:develop:api:efl:net:socket_ssl:event:ssl_ready|ssl,ready]]** | %%Notifies the SSL handshake has been performed and the socket is now able to communicate%% | ^ [[:develop:api:efl:object|Efl.Object]] ^^^ | | **[[:develop:api:efl:object:event:del|del]]** | %%Object is being deleted. See %%[[:develop:api:efl:object:method:destructor|Efl.Object.destructor]]%%.%% | | | **[[:develop:api:efl:object:event:destruct|destruct]]** | %%Object has been fully destroyed. It can not be used beyond this point. This event should only serve to clean up any reference you keep to the object.%% | | | **[[:develop:api:efl:object:event:invalidate|invalidate]]** | %%Object is being invalidated and losing its parent. See %%[[:develop:api:efl:object:method:invalidate|Efl.Object.invalidate]]%%.%% | | | **[[:develop:api:efl:object:event:noref|noref]]** | %%Object has lost its last reference, only parent relationship is keeping it alive. Advanced usage.%% | | | **[[:develop:api:efl:object:event:ownership_shared|ownership,shared]]** | %%Object has acquired a second reference. It has multiple owners now. Triggered whenever increasing the refcount from one to two, it will not trigger by further increasing the refcount beyond two.%% | | | **[[:develop:api:efl:object:event:ownership_unique|ownership,unique]]** | %%Object has lost a reference and only one is left. It has just one owner now. Triggered whenever the refcount goes from two to one.%% |