docs/reference/tmpl/lm-ssl.sgml
changeset 82 a32b54e654e2
parent 72 95d0e86982c5
child 140 103227122f45
equal deleted inserted replaced
81:b9dfe6efc011 82:a32b54e654e2
     4 <!-- ##### SECTION Short_Description ##### -->
     4 <!-- ##### SECTION Short_Description ##### -->
     5 SSL struct for SSL support in Loudmouth
     5 SSL struct for SSL support in Loudmouth
     6 
     6 
     7 <!-- ##### SECTION Long_Description ##### -->
     7 <!-- ##### SECTION Long_Description ##### -->
     8 <para>
     8 <para>
     9 Use this together with an #LmConnection to get the connection to use SSL.
     9 Use this together with an #LmConnection to get the connection to use SSL. Example of how to use the #LmSSL API.
    10 </para>
    10 </para>
       
    11 <informalexample><programlisting><![CDATA[
       
    12 LmConnection *connection;
       
    13 LmSSL        *ssl;
       
    14 
       
    15 connection = lm_connection_new ("myserver");
       
    16 ssl = lm_ssl_new (NULL, my_ssl_func, NULL, NULL);
       
    17 lm_connection_set_ssl (connection, ssl);
       
    18 ...
       
    19 ]]></programlisting></informalexample>
    11 
    20 
    12 <!-- ##### SECTION See_Also ##### -->
    21 <!-- ##### SECTION See_Also ##### -->
    13 <para>
    22 <para>
    14 
    23 
    15 </para>
    24 </para>
       
    25 
       
    26 <!-- ##### STRUCT LmSSL ##### -->
       
    27 <para>
       
    28 This should not be accessed directly. Use the accessor functions as described below.
       
    29 </para>
       
    30 
    16 
    31 
    17 <!-- ##### ENUM LmCertificateStatus ##### -->
    32 <!-- ##### ENUM LmCertificateStatus ##### -->
    18 <para>
    33 <para>
    19 Provides information of the status of a certain certificate.
    34 Provides information of the status of a certain certificate.
    20 </para>
    35 </para>
    47 <!-- ##### USER_FUNCTION LmSSLFunction ##### -->
    62 <!-- ##### USER_FUNCTION LmSSLFunction ##### -->
    48 <para>
    63 <para>
    49 This function is called if something goes wrong during the connecting phase.
    64 This function is called if something goes wrong during the connecting phase.
    50 </para>
    65 </para>
    51 
    66 
    52 @ssl: An #LmSSL. 
    67 @ssl: An #LmSSL.
    53 @status: The status informing what went wrong.
    68 @status: The status informing what went wrong.
    54 @user_data: User data provided in the callback.
    69 @user_data: User data provided in the callback.
    55 @Returns: User should return #LM_SSL_RESPONSE_CONTINUE if connection should proceed and otherwise #LM_SSL_RESPONSE_STOP.
    70 @Returns: User should return #LM_SSL_RESPONSE_CONTINUE if connection should proceed and otherwise #LM_SSL_RESPONSE_STOP.
    56 
    71 
    57 
    72