libwslay-doc 1.0.1~39-g6abacc1-3 / usr / share / doc / libwslay-dev / html / searchindex.js

Search.setIndex({docnames:["api_reference","index","man/wslay_event_config_set_allowed_rsv_bits","man/wslay_event_config_set_callbacks","man/wslay_event_config_set_max_recv_msg_length","man/wslay_event_config_set_no_buffering","man/wslay_event_context_server_init","man/wslay_event_get_close_received","man/wslay_event_get_close_sent","man/wslay_event_get_queued_msg_count","man/wslay_event_get_queued_msg_length","man/wslay_event_get_read_enabled","man/wslay_event_get_status_code_received","man/wslay_event_get_status_code_sent","man/wslay_event_get_write_enabled","man/wslay_event_queue_close","man/wslay_event_queue_fragmented_msg","man/wslay_event_queue_msg","man/wslay_event_recv","man/wslay_event_send","man/wslay_event_set_error","man/wslay_event_shutdown_read","man/wslay_event_shutdown_write","man/wslay_event_want_read","man/wslay_event_want_write","tutorial"],envversion:53,filenames:["api_reference.rst","index.rst","man/wslay_event_config_set_allowed_rsv_bits.rst","man/wslay_event_config_set_callbacks.rst","man/wslay_event_config_set_max_recv_msg_length.rst","man/wslay_event_config_set_no_buffering.rst","man/wslay_event_context_server_init.rst","man/wslay_event_get_close_received.rst","man/wslay_event_get_close_sent.rst","man/wslay_event_get_queued_msg_count.rst","man/wslay_event_get_queued_msg_length.rst","man/wslay_event_get_read_enabled.rst","man/wslay_event_get_status_code_received.rst","man/wslay_event_get_status_code_sent.rst","man/wslay_event_get_write_enabled.rst","man/wslay_event_queue_close.rst","man/wslay_event_queue_fragmented_msg.rst","man/wslay_event_queue_msg.rst","man/wslay_event_recv.rst","man/wslay_event_send.rst","man/wslay_event_set_error.rst","man/wslay_event_shutdown_read.rst","man/wslay_event_shutdown_write.rst","man/wslay_event_want_read.rst","man/wslay_event_want_write.rst","tutorial.rst"],objects:{"":{communicate:[25,0,1,"c.communicate"],wslay_event_config_set_allowed_rsv_bits:[2,0,1,"c.wslay_event_config_set_allowed_rsv_bits"],wslay_event_config_set_callbacks:[3,0,1,"c.wslay_event_config_set_callbacks"],wslay_event_config_set_max_recv_msg_length:[4,0,1,"c.wslay_event_config_set_max_recv_msg_length"],wslay_event_config_set_no_buffering:[5,0,1,"c.wslay_event_config_set_no_buffering"],wslay_event_context_client_init:[6,0,1,"c.wslay_event_context_client_init"],wslay_event_context_free:[6,0,1,"c.wslay_event_context_free"],wslay_event_context_server_init:[6,0,1,"c.wslay_event_context_server_init"],wslay_event_fragmented_msg_callback:[16,1,1,"c.wslay_event_fragmented_msg_callback"],wslay_event_genmask_callback:[6,1,1,"c.wslay_event_genmask_callback"],wslay_event_get_close_received:[7,0,1,"c.wslay_event_get_close_received"],wslay_event_get_close_sent:[8,0,1,"c.wslay_event_get_close_sent"],wslay_event_get_queued_msg_count:[9,0,1,"c.wslay_event_get_queued_msg_count"],wslay_event_get_queued_msg_length:[10,0,1,"c.wslay_event_get_queued_msg_length"],wslay_event_get_read_enabled:[11,0,1,"c.wslay_event_get_read_enabled"],wslay_event_get_status_code_received:[12,0,1,"c.wslay_event_get_status_code_received"],wslay_event_get_status_code_sent:[13,0,1,"c.wslay_event_get_status_code_sent"],wslay_event_get_write_enabled:[14,0,1,"c.wslay_event_get_write_enabled"],wslay_event_on_frame_recv_chunk_callback:[6,1,1,"c.wslay_event_on_frame_recv_chunk_callback"],wslay_event_on_frame_recv_end_callback:[6,1,1,"c.wslay_event_on_frame_recv_end_callback"],wslay_event_on_frame_recv_start_callback:[6,1,1,"c.wslay_event_on_frame_recv_start_callback"],wslay_event_on_msg_recv_callback:[6,1,1,"c.wslay_event_on_msg_recv_callback"],wslay_event_queue_close:[15,0,1,"c.wslay_event_queue_close"],wslay_event_queue_fragmented_msg:[16,0,1,"c.wslay_event_queue_fragmented_msg"],wslay_event_queue_fragmented_msg_ex:[16,0,1,"c.wslay_event_queue_fragmented_msg_ex"],wslay_event_queue_msg:[17,0,1,"c.wslay_event_queue_msg"],wslay_event_queue_msg_ex:[17,0,1,"c.wslay_event_queue_msg_ex"],wslay_event_recv:[18,0,1,"c.wslay_event_recv"],wslay_event_recv_callback:[6,1,1,"c.wslay_event_recv_callback"],wslay_event_send:[19,0,1,"c.wslay_event_send"],wslay_event_send_callback:[6,1,1,"c.wslay_event_send_callback"],wslay_event_set_error:[20,0,1,"c.wslay_event_set_error"],wslay_event_shutdown_read:[21,0,1,"c.wslay_event_shutdown_read"],wslay_event_shutdown_write:[22,0,1,"c.wslay_event_shutdown_write"],wslay_event_want_read:[23,0,1,"c.wslay_event_want_read"],wslay_event_want_write:[24,0,1,"c.wslay_event_want_write"]}},objnames:{"0":["c","function","C function"],"1":["c","type","C type"]},objtypes:{"0":"c:function","1":"c:type"},terms:{"break":25,"byte":[6,15,16],"case":[18,19],"const":[3,6,15,16,17,25],"default":4,"function":[2,3,4,5,6,15,16,17,18,19,20,21,23,24,25],"import":6,"int":[5,6,7,8,11,14,15,16,17,18,19,20,23,24,25],"new":[6,18,19],"null":25,"return":[7,8,9,10,11,12,13,14,25],"void":[2,3,4,5,6,16,20,21,22,25],"while":25,For:[1,16,25],The:[2,3,4,5,6,15,16,17,25],Then:25,There:6,accept:[16,17,25],across:1,addition:[16,17],after:[5,11,14,19,25],all:[16,25],alloc:6,allow:[2,11,14,15,16,17],also:25,alwai:[2,5,6],ani:[1,6,18,19,21,22,25],anoth:25,api:[1,6,11,14,21,22,25],applic:[1,18,19,21],arbitrari:6,arg:[6,16,17,25],argument:[6,18,19],assum:6,author:1,autobahn:1,automat:[1,18],back:25,base:[1,6,11,14,21,22,25],basic:25,becaus:6,been:[7,8,12,13,15,16,17],behaviour:6,binari:1,bit:[2,6,16,17],bitwis:6,block:[1,6,25],both:[2,17,25],briefli:25,buf:[6,16,25],buffer:[4,5],build:25,call:[4,5,11,14,15,16,17,18,19,25],callback:[1,3,6,16,18,19,20,25],can:[1,4,15,16,25],caus:6,check:[2,4],child:25,choos:1,chunk:[6,18],client:[1,6,19,25],close:[4,6,7,8,12,13,15,16,17,18,19,25],code:[6,12,13,15,16,17,18,19,20,25],com:1,command:25,commun:25,complet:[6,18,25],connect:[18,19,21,25],construct:6,contain:[16,25],content:[0,1],context:[6,11,14,21,22,25],control:[4,5,6,7,8,12,13,15,16,17,18,19,25],conveni:15,copi:17,could:[15,16,17],count:10,ctx:[2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25],current:2,data:[1,6,16,17,21,22,23,24,25],data_length:6,decid:[23,24],defin:[6,16,17,18,19,20],depend:25,describ:[1,6,25],descriptor:25,detail:18,detect:21,directli:[1,6],disabl:[2,4,5,18,19],doe:[1,4,15,16,17,20],don:25,done:25,each:[4,6,18],eagain:[6,25],echo:1,echoserv:25,effect:4,eintr:25,either:25,els:25,enabl:5,encod:15,endif:25,entir:[4,5],eof:[16,25],errno:25,error:[6,15,16,17,18,19,20,21,25],establish:25,etc:1,event:[1,6,11,14,18,21,22,23,24,25],ewouldblock:[6,25],exactli:6,exampl:25,exit:25,extens:2,extern:1,fail:[18,19,21,25],fatal:[18,19],file:25,fill:6,fin:6,finish:25,first:[5,25],flag:[6,25],focu:25,follow:[6,15,16,17,18,19],fork:25,fragment:[16,17],frame:[1,2,4,5,6,7,8,12,13,15,16,17,18,19,25],framework:1,free:6,freeli:1,from:[6,7,16,18,21,22,23,25],further:[6,15,16,17,18,19,21,22,25],gener:16,genmask_callback:6,get:19,github:1,given:[15,16,17,25],goe:25,handshak:[1,25],has:[7,8,12,13,15,16,17],have:25,here:25,hint:6,hold:6,host:1,how:25,http:[1,25],http_handshak:25,ifdef:25,ignor:2,implement:[1,6,16],includ:[2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24],incom:25,independ:1,initi:[6,19,25],instead:[1,6,17],interfac:1,invalid:[15,16,17],invoc:5,invok:[5,6,19,25],its:1,just:[15,16,17,25],kei:[6,19],know:[20,23,24],larger:4,lead:[18,19],len:[6,16,25],length:[4,6,10,15,17,25],less:15,let:25,level:1,librari:[4,20,23,24,25],like:25,line:25,listen:25,locat:25,longer:6,look:25,loop:[1,25],low:1,macro:[16,17],made:25,mai:[21,25],make:[1,17,18,19,25],mask:[2,6,19],maximum:4,mean:25,mechan:25,member:[5,6,16,17],memori:[6,15,16,17,18,19],messag:[1,4,5,6,9,10,15,16,17,18,19,25],moment:16,more:[6,23,24,25],most:[6,16,25],msg:[6,17,25],msg_length:[5,6,17,25],msg_more:25,msgarg:25,multipl:[18,19],must:[5,6,15,16,18,19,25],necessari:6,need:[6,17,25],neg:[6,15,16,17,18,19],non:[1,4,5,6,16,17,25],normal:16,notic:25,notif:[23,24,25],now:25,number:[6,9,16],occur:25,offer:1,on_frame_recv_chunk_callback:6,on_frame_recv_end_callback:6,on_frame_recv_start_callback:6,on_msg_recv_callback:[6,25],onc:6,one:[6,15,16,17,18,19],onli:[1,2,6,10,16,25],opcod:[6,16,17,25],open:1,oper:[1,4,11,14],option:25,other:[2,6,25],otherwis:[5,19],out:[6,15,16,17,18,19],own:[1,18],paramet:[16,17],parent:25,part:1,pass:6,pattern:1,payload:[4,6,15,18],payload_length:6,peer:[6,7,8,18,19,21,22,23,24],pend:19,perform:[1,6,25],permit:2,perror:25,ping:[1,18],platform:1,pmce:2,point:[6,25],pointer:[6,17],poll:[23,24,25],pollerr:25,pollhup:25,pollin:25,pollnval:25,pollout:25,pong:18,port:25,possibl:[15,16,17],prevent:[21,22,25],previous:3,primari:25,process:[6,25],project:1,protabl:1,protocol:[1,6],provid:[6,15],purpos:25,queri:25,queu:[4,9,10,15,16,17,19],queue:[15,16,17,18,25],reactor:1,read:[4,6,11,16,18,21,23,25],read_callback:16,reason:[15,16,17,25],reason_length:15,receiv:[4,6,7,12,18,21,25],recept:2,recv:25,recv_callback:[6,25],refer:1,regardless:5,replac:3,repli:1,report:1,res:25,reserv:[2,6,16,17],resourc:6,respect:6,revent:25,rfc6455:6,rfc:[1,2],rsv1:[6,17],rsv2:6,rsv3:6,rsv:[2,6,16,17],run:25,same:4,second:[18,19],section:25,see:[1,20],select:[23,24],send:[1,6,15,16,17,19,22,24,25],send_callback:[6,25],sent:[6,8,13,15,16,17,19],seriou:25,server:[1,6],session:25,set:[1,2,3,4,5,6,16,17,18,19,20,25],sflag:25,should:20,shut_wr:25,shutdown:25,similar:25,simpli:2,sinc:25,singl:[18,19],size_t:[6,9,10,15,16,17,25],socket:[1,25],some:6,sourc:[16,25],specifi:[16,17],ssize_t:[6,16,25],ssl:1,standard:25,start:[6,18,25],statu:[6,12,13,15],status_cod:[6,15],stop:[6,25],store:[6,16],struct:[3,5,6,16,17,25],structur:6,style:1,succe:[2,6,15,16,17,18,19,25],success:6,successfulli:6,suitabl:1,sum:10,support:[1,16,17],tatsuhiro:1,tcp_nodelai:25,tell:[6,20,25],test:1,text:1,than:[2,4,15],thei:6,them:[1,6],thi:[1,2,3,4,5,6,15,16,17,18,19,20,21,23,24,25],those:2,traffic:6,transfer:[1,6,25],transmiss:[2,19],treat:25,tune:6,tutori:1,typedef:[6,16],typic:20,uint16_t:[6,12,13,15],uint64_t:[4,6],uint8_t:[2,6,15,16,17,25],unexpect:25,union:16,until:[18,19,25],use:[6,16,17,19,25],used:[2,5,6,15,20,21,23,24],useful:[23,24],user:[18,19,20],user_data:[6,16,25],uses:[18,19],using:[6,10,16,19,25],utf:15,val:[4,5,20],valid:2,valu:[4,25],variou:1,version:[1,6],wait:[23,24],want:[6,21,23,24,25],websocket:[2,6,18,19,21],well:15,when:[2,5,6,18,19,25],whether:[23,24],which:[6,16,17,18,19,20,25],whole:6,without:17,word:6,write:[14,24,25],written:1,wslai:[2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25],wslay_code_abnormal_closur:[12,13],wslay_code_message_too_big:4,wslay_code_no_status_rcvd:[12,13],wslay_connection_clos:6,wslay_err_callback_fail:25,wslay_err_callback_failur:[6,16,18,19,25],wslay_err_invalid_argu:[15,16,17],wslay_err_no_more_msg:[15,16,17],wslay_err_nomem:[6,15,16,17,18,19],wslay_err_wouldblock:[6,18,19,25],wslay_event_callback:[3,6,25],wslay_event_config_set_allowed_rsv_bit:[0,1,16,17],wslay_event_config_set_callback:[0,1],wslay_event_config_set_max_recv_msg_length:[0,1],wslay_event_config_set_no_buff:[0,1],wslay_event_context_client_init:[0,1,3,18],wslay_event_context_fre:[0,1],wslay_event_context_ptr:[2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25],wslay_event_context_server_init:[0,1,3,18,25],wslay_event_fragmented_msg:16,wslay_event_fragmented_msg_callback:[16,19],wslay_event_genmask_callback:[6,19],wslay_event_get_close_receiv:[0,1],wslay_event_get_close_s:[0,1,7],wslay_event_get_queued_msg_count:[0,1],wslay_event_get_queued_msg_length:[0,1],wslay_event_get_read_en:[0,1,21,23],wslay_event_get_status_code_receiv:[0,1,13],wslay_event_get_status_code_s:[0,1,12],wslay_event_get_write_en:[0,1,22,24],wslay_event_msg:[17,25],wslay_event_msg_sourc:16,wslay_event_on_frame_recv_chunk_arg:6,wslay_event_on_frame_recv_chunk_callback:[6,18],wslay_event_on_frame_recv_end_callback:[6,18],wslay_event_on_frame_recv_start_arg:6,wslay_event_on_frame_recv_start_callback:[6,18],wslay_event_on_msg_recv_arg:[5,6,25],wslay_event_on_msg_recv_callback:[5,6,18],wslay_event_queue_clos:[0,1,10,16,17,21],wslay_event_queue_fragmented_msg:[0,1,2,15,17,19],wslay_event_queue_fragmented_msg_ex:[0,1,2,17],wslay_event_queue_msg:[0,1,10,15,16,25],wslay_event_queue_msg_ex:[0,1,16],wslay_event_recv:[0,1,4,5,6,25],wslay_event_recv_callback:[6,18],wslay_event_send:[0,1,6,15,16,17,25],wslay_event_send_callback:[6,19],wslay_event_set_error:[0,1,6,16,25],wslay_event_set_read_en:18,wslay_event_set_write_en:19,wslay_event_shutdown_read:[0,1,4,11,23],wslay_event_shutdown_writ:[0,1,14,24],wslay_event_want_read:[0,1,24,25],wslay_event_want_writ:[0,1,19,23,25],wslay_is_ctrl_fram:25,wslay_msg_mor:[6,25],wslay_rsv1_bit:[2,16,17],wslay_rsv2_bit:[16,17],wslay_rsv3_bit:[16,17],wslay_rsv_non:2,you:[1,25],zero:[6,15,25]},titles:["API Reference","Wslay - The WebSocket library","wslay_event_config_set_allowed_rsv_bits","wslay_event_config_set_callbacks","wslay_event_config_set_max_recv_msg_length","wslay_event_config_set_no_buffering","wslay_event_context_server_init, wslay_event_context_client_init, wslay_event_context_free","wslay_event_get_close_received","wslay_event_get_close_sent","wslay_event_get_queued_msg_count","wslay_event_get_queued_msg_length","wslay_event_get_read_enabled","wslay_event_get_status_code_received","wslay_event_get_status_code_sent","wslay_event_get_write_enabled","wslay_event_queue_close","wslay_event_queue_fragmented_msg, wslay_event_queue_fragmented_msg_ex","wslay_event_queue_msg, wslay_event_queue_msg_ex","wslay_event_recv","wslay_event_send","wslay_event_set_error","wslay_event_shutdown_read","wslay_event_shutdown_write","wslay_event_want_read","wslay_event_want_write","Tutorial"],titleterms:{"return":[2,6,15,16,17,18,19,20,23,24],The:1,also:[2,3,4,5,6,7,8,11,12,13,14,15,16,17,18,19,21,22,23,24],api:0,descript:[2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24],echo:25,librari:1,refer:0,see:[2,3,4,5,6,7,8,11,12,13,14,15,16,17,18,19,21,22,23,24],server:25,synopsi:[2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24],tutori:25,valu:[2,6,15,16,17,18,19,20,23,24],websocket:[1,25],wslai:1,wslay_event_config_set_allowed_rsv_bit:2,wslay_event_config_set_callback:3,wslay_event_config_set_max_recv_msg_length:4,wslay_event_config_set_no_buff:5,wslay_event_context_client_init:6,wslay_event_context_fre:6,wslay_event_context_server_init:6,wslay_event_get_close_receiv:7,wslay_event_get_close_s:8,wslay_event_get_queued_msg_count:9,wslay_event_get_queued_msg_length:10,wslay_event_get_read_en:11,wslay_event_get_status_code_receiv:12,wslay_event_get_status_code_s:13,wslay_event_get_write_en:14,wslay_event_queue_clos:15,wslay_event_queue_fragmented_msg:16,wslay_event_queue_fragmented_msg_ex:16,wslay_event_queue_msg:17,wslay_event_queue_msg_ex:17,wslay_event_recv:18,wslay_event_send:19,wslay_event_set_error:20,wslay_event_shutdown_read:21,wslay_event_shutdown_writ:22,wslay_event_want_read:23,wslay_event_want_writ:24}})