X-Git-Url: http://git.silcnet.org/gitweb/?a=blobdiff_plain;f=lib%2Fsilcclient%2Fsilcclient.h;h=dd3e5cb1a46a30506b8bfc017ae520e92ca8989c;hb=2ee2102bc017e6e713c9c4e8260a46424d30b977;hp=87c3b97c84ac77a4c1486b1d595ee64681c32d54;hpb=0bec4ad52aee68c17d256ab266ff0bfda338dd52;p=silc.git diff --git a/lib/silcclient/silcclient.h b/lib/silcclient/silcclient.h index 87c3b97c..dd3e5cb1 100644 --- a/lib/silcclient/silcclient.h +++ b/lib/silcclient/silcclient.h @@ -409,6 +409,26 @@ typedef struct { void (*ftp)(SilcClient client, SilcClientConnection conn, SilcClientEntry client_entry, SilcUInt32 session_id, const char *hostname, SilcUInt16 port); + + /* Delivers SILC session detachment data indicated by `detach_data' to the + application. If application has issued SILC_COMMAND_DETACH command + the client session in the SILC network is not quit. The client remains + in the network but is detached. The detachment data may be used later + to resume the session in the SILC Network. The appliation is + responsible of saving the `detach_data', to for example in a file. + + The detachment data can be given as argument to the functions + silc_client_connect_to_server, or silc_client_add_connection when + creating connection to remote server, inside SilcClientConnectionParams + structure. If it is provided the client library will attempt to resume + the session in the network. After the connection is created + successfully, the application is responsible of setting the user + interface for user into the same state it was before detaching (showing + same channels, channel modes, etc). It can do this by fetching the + information (like joined channels) from the client library. */ + void (*detach)(SilcClient client, SilcClientConnection conn, + const unsigned char *detach_data, + SilcUInt32 detach_data_len); } SilcClientOperations; /***/ @@ -640,7 +660,14 @@ typedef struct { /* The SILC session detachment data that was returned by `detach' client operation when the application detached from the network. Application is responsible of saving the data and giving it as argument here - for resuming the session in the SILC network. */ + for resuming the session in the SILC network. + + If this is provided here the client library will attempt to resume + the session in the network. After the connection is created + successfully, the application is responsible of setting the user + interface for user into the same state it was before detaching (showing + same channels, channel modes, etc). It can do this by fetching the + information (like joined channels) from the client library. */ unsigned char *detach_data; SilcUInt32 detach_data_len;