src/irc_conn.h
changeset 28 9c1050bc8709
parent 27 e6639132bead
child 29 3f0f2898fea3
equal deleted inserted replaced
27:e6639132bead 28:9c1050bc8709
    83  */
    83  */
    84 err_t irc_conn_create (struct irc_conn **conn, struct sock_stream *sock, const struct irc_conn_callbacks *callbacks, 
    84 err_t irc_conn_create (struct irc_conn **conn, struct sock_stream *sock, const struct irc_conn_callbacks *callbacks, 
    85         void *cb_arg, struct error_info *err);
    85         void *cb_arg, struct error_info *err);
    86 
    86 
    87 /**
    87 /**
       
    88  * Destroy the irc_conn state, terminating any connection and releasing all resources.
       
    89  *
       
    90  * This does not end the session cleanly, and is intended mainly to be used after clean exit, or to clean up after errors.
       
    91  */
       
    92 void irc_conn_destroy (struct irc_conn *conn);
       
    93 
       
    94 /**
    88  * Add a new chain of command handler callbacks to be used to handle irc_lines from the server. The given arg will be
    95  * Add a new chain of command handler callbacks to be used to handle irc_lines from the server. The given arg will be
    89  * passed to the callbacks as the context argument. The chain will be appended to the end of the current list of chains.
    96  * passed to the callbacks as the context argument. The chain will be appended to the end of the current list of chains.
    90  *
    97  *
    91  * XXX: rename to not conflict with irc_conn_register()
    98  * XXX: rename to not conflict with irc_conn_register()
    92  *
    99  *