amps-python-client 5.3.4.2__zip → 5.3.4.4__zip

{amps-python-client-5.3.4.2 → amps-python-client-5.3.4.4}/docs/python-quickstart/html/searchindex.js

@@ -1 +1 @@
-Search.setIndex({docnames:["chapters/crankitup","chapters/equipment","index"],envversion:51,filenames:["chapters/crankitup.rst","chapters/equipment.rst","index.rst"],objects:{},objnames:{},objtypes:{},terms:{"case":[0,2],"new":[0,2],"public":2,"try":2,And:2,For:[0,2],IDE:[0,2],One:[0,2],THE:[0,2],The:[0,1,2],Then:2,With:[0,2],abl:[0,2],about:2,acknowledg:2,add:[0,2],address:[0,2],administr:2,advanc:2,advantag:2,again:[0,2],all:[0,2],allow:[0,2],alreadi:[1,2],also:[0,2],alwai:[0,2],amp:[0,1],amps_dir:2,amps_sow_dump:2,ampsconsolepublish:[0,2],ampsconsolesubscrib:[0,2],ampserv:2,ampssowandsubscribeconsolesubscrib:[0,2],ampssowandsubscribewithoof:[0,2],ampssowconsolepublish:[0,2],ampssowconsolesubscrib:[0,2],ampssowpublish:2,ampsupdateforoof:[0,2],analysi:2,ani:[0,2],annot:2,anoth:[0,2],applic:2,ask:[0,2],avail:[0,1,2],background:[0,2],been:[0,2],befor:[0,2],behind:2,being:[0,2],bin:2,binari:[0,2],both:[0,2],bson:2,buffer:2,built:[0,2],calcul:2,can:[0,1,2],caus:[0,2],certain:2,chang:[0,2],choic:[1,2],claus:2,client:1,cmd:[1,2],com:[0,1,2],command:[0,2],compar:[0,2],complet:2,compromis:2,comput:2,concept:2,config:2,configur:2,connect:[0,2],consist:2,consol:[0,2],content:[0,2],continu:[0,2],convent:[0,2],copi:2,crankitup:[0,2],crankuptheamp:[0,1,2],crash:2,creat:[0,1,2],current:[0,2],data:[1,2],date:2,defin:2,definit:2,delet:[0,2],deliv:[0,2],deliveri:2,delta:2,demand:2,describ:[0,1,2],design:2,detail:2,develop:[1,2],devnul:[0,2],diagnost:2,did:2,difficulti:[0,2],directori:[0,2],disk:[1,2],displaykc:[1,2],distribut:[0,1,2],document:[1,2],doe:[0,2],download:[1,2],dump:2,durabl:2,each:[0,2],earlier:[0,2],eas:2,easi:2,eclips:[0,2],either:[0,2],en_u:[1,2],enabl:[1,2],end:[0,2],engin:2,enough:[1,2],enrich:2,ensur:[0,2],evalu:[0,1,2],ever:2,exactli:2,exampl:[0,1,2],exit:[0,2],expir:[0,2],explor:2,extens:[0,2],externalid:[1,2],extract:2,extrem:2,familiar:2,featur:2,few:2,field:[0,2],file:[1,2],fill:2,filter:[0,2],fix:2,follow:[0,2],foreach:[0,2],forward:2,from:[0,2],fulfil:[0,2],full:[0,2],gci:[0,2],get:0,give:2,googl:2,great:2,guid:[0,2],handl:2,hardest:2,hardwar:2,has:2,have:[0,1,2],hello:[0,2],help:[0,2],here:[0,2],high:2,highest:2,histor:2,hold:[1,2],host:[1,2],how:2,http:[0,1,2],identifi:[0,2],ignore_m:[0,2],includ:[0,2],incom:2,inform:[0,2],instal:[0,1,2],instanc:2,intend:[1,2],interfac:2,item:[0,2],itself:[0,2],join:2,json:2,jun:2,just:2,keep:0,kind:[0,2],kit:[0,1,2],know:2,languag:[1,2],latenc:2,later:[0,2],latest:[0,1,2],learn:2,less:[0,2],level:2,lightweight:2,line:[0,2],linux:[0,1,2],list:[0,2],local:[1,2],longer:[0,2],low:2,lowest:2,machin:[1,2],mai:[0,2],maintain:[0,2],make:1,match:[0,2],maxim:2,mean:[0,2],memori:[1,2],messagenumb:[0,2],messagepack:2,microsit:[1,2],minidump:2,mkdir:2,model:2,modern:2,modifi:2,monitor:2,more:2,most:[0,1,2],multipl:[0,2],must:[0,2],name:2,navig:[0,2],need:[1,2],note:[0,2],notic:[0,2],notif:[0,2],notifi:[0,2],nvfix:2,object:[0,2],one:2,open:[0,2],optim:2,option:[0,2],order:[0,2],org:[1,2],out:1,output:[0,2],outsid:2,overload:2,page:[0,2],part:[0,1,2],passeng:[0,2],path:[0,2],perform:2,persist:2,pick:[0,2],plai:2,point:2,possibl:2,powershel:[0,2],pre:[0,2],prefer:[0,2],present:[0,2],previou:[0,2],print:[0,2],problem:2,process:2,produc:[0,2],program:[0,2],project:2,protocol:2,provid:[0,2],pub:2,publish:[0,2],pydev:[0,2],python:[0,1],queri:[0,2],question:2,queu:2,queue:2,rang:2,rather:[0,2],real:2,receiv:[0,2],recent:[0,2],releas:[0,2],reliabl:2,remix:2,replac:[0,2],replai:2,replic:2,request:[0,2],result:[0,2],retriev:[0,2],run:[0,2],sai:[0,2],same:2,sampl:[0,2],save:[0,2],search:[1,2],section:[0,2],sed:[0,2],see:[0,2],select:2,selfservic:[1,2],semant:2,send:[0,2],sent:[0,2],server:2,set:[0,2],setup:[0,2],shell:[0,2],ship:[0,2],show:[0,2],simpl:[0,2],solut:2,solv:2,some:2,sourc:[0,2],sow:[0,2],space:[1,2],special:[0,2],sql92:2,sql:2,standard:2,start:[0,2],still:2,string:[0,2],sub:2,subscrib:[0,2],subscript:2,success:[0,2],sudo:[0,2],suggest:2,support:2,sure:[1,2],system:[0,2],take:2,taxi:[0,2],technolog:[1,2],than:[0,2],thei:2,them:[0,2],thi:[0,1,2],time:[0,2],tool:2,topic:[0,2],touch:2,track:[0,2],tradit:[0,2],transact:2,troubl:2,tune:2,two:[0,2],type:[0,2],uncompromis:2,understand:2,uniqu:[0,2],unzip:[0,2],updat:[0,2],use:[0,1,2],useful:[0,2],user:2,uses:2,using:[0,2],valu:[0,2],verifi:2,version:[0,2],view:2,virtual:[1,2],virtualbox:[1,2],visit:[1,2],vmware:[1,2],volum:2,wai:2,wait:[0,2],want:[0,2],where:[0,2],which:[0,1,2],window:[0,2],within:2,without:2,work:[0,2],write:2,xml:2,yet:[0,2],you:[0,1,2],your:[0,1,2]},titles:["Building the Client","Get the Equipment","AMPS Python Client QuickStart"],titleterms:{Going:2,Using:[0,2],amp:2,better:2,build:[0,2],client:[0,2],crank:[0,2],databas:[0,2],detect:[0,2],differ:2,equip:[1,2],faster:2,focu:[0,2],get:[1,2],keep:2,louder:2,make:2,messag:[0,2],out:[0,2],python:2,quickstart:2,state:[0,2],turn:2,welcom:2,what:2,when:[0,2],world:[0,2]}})
+Search.setIndex({docnames:["chapters/crankitup","chapters/equipment","index"],envversion:51,filenames:["chapters/crankitup.rst","chapters/equipment.rst","index.rst"],objects:{},objnames:{},objtypes:{},terms:{"case":[0,2],"new":[0,2],"public":2,"try":2,And:2,For:[0,2],IDE:[0,2],One:[0,2],THE:[0,2],The:[0,1,2],Then:2,With:[0,2],abl:[0,2],about:2,acknowledg:2,add:[0,2],address:[0,2],administr:2,advanc:2,advantag:2,again:[0,2],all:[0,2],allow:[0,2],alreadi:[1,2],also:[0,2],alwai:[0,2],amp:[0,1],amps_dir:2,amps_sow_dump:2,ampsconsolepublish:[0,2],ampsconsolesubscrib:[0,2],ampserv:2,ampssowandsubscribeconsolesubscrib:[0,2],ampssowandsubscribewithoof:[0,2],ampssowconsolepublish:[0,2],ampssowconsolesubscrib:[0,2],ampssowpublish:2,ampsupdateforoof:[0,2],analysi:2,ani:[0,2],annot:2,anoth:[0,2],applic:2,ask:[0,2],avail:[0,1,2],background:[0,2],been:[0,2],befor:[0,2],behind:2,being:[0,2],bin:2,binari:[0,2],both:[0,2],bson:2,buffer:2,built:[0,2],calcul:2,can:[0,1,2],caus:[0,2],certain:2,chang:[0,2],choic:[1,2],claus:2,client:1,cmd:[1,2],com:[0,1,2],command:[0,2],compar:[0,2],complet:2,compromis:2,comput:2,concept:2,config:2,configur:2,connect:[0,2],consist:2,consol:[0,2],content:[0,2],continu:[0,2],convent:[0,2],copi:2,crankitup:[0,2],crankuptheamp:[0,1,2],crash:2,creat:[0,1,2],current:[0,2],data:[1,2],date:2,defin:2,definit:2,delet:[0,2],deliv:[0,2],deliveri:2,delta:2,demand:2,describ:[0,1,2],design:2,detail:2,develop:[1,2],devnul:[0,2],diagnost:2,did:2,difficulti:[0,2],directori:[0,2],disk:[1,2],displaykc:[1,2],distribut:[0,1,2],document:[1,2],doe:[0,2],download:[1,2],dump:2,durabl:2,each:[0,2],earlier:[0,2],eas:2,easi:2,eclips:[0,2],either:[0,2],en_u:[1,2],enabl:[1,2],end:[0,2],engin:2,enough:[1,2],enrich:2,ensur:[0,2],evalu:[0,1,2],ever:2,exactli:2,exampl:[0,1,2],exit:[0,2],expir:[0,2],explor:2,extens:[0,2],externalid:[1,2],extract:2,extrem:2,familiar:2,featur:2,few:2,field:[0,2],file:[1,2],fill:2,filter:[0,2],fix:2,follow:[0,2],foreach:[0,2],forward:2,from:[0,2],fulfil:[0,2],full:[0,2],gci:[0,2],get:0,give:2,googl:2,great:2,guid:[0,2],handl:2,hardest:2,hardwar:2,has:2,have:[0,1,2],hello:[0,2],help:[0,2],here:[0,2],high:2,highest:2,histor:2,hold:[1,2],host:[1,2],how:2,http:[0,1,2],identifi:[0,2],ignore_m:[0,2],includ:[0,2],incom:2,inform:[0,2],instal:[0,1,2],instanc:2,intend:[1,2],interfac:2,item:[0,2],itself:[0,2],join:2,json:2,just:2,keep:0,kind:[0,2],kit:[0,1,2],know:2,languag:[1,2],latenc:2,later:[0,2],latest:[0,1,2],learn:2,less:[0,2],level:2,lightweight:2,line:[0,2],linux:[0,1,2],list:[0,2],local:[1,2],longer:[0,2],low:2,lowest:2,machin:[1,2],mai:[0,2],maintain:[0,2],make:1,match:[0,2],maxim:2,mean:[0,2],memori:[1,2],messagenumb:[0,2],messagepack:2,microsit:[1,2],minidump:2,mkdir:2,model:2,modern:2,modifi:2,monitor:2,more:2,most:[0,1,2],multipl:[0,2],must:[0,2],name:2,navig:[0,2],need:[1,2],note:[0,2],notic:[0,2],notif:[0,2],notifi:[0,2],nvfix:2,object:[0,2],one:2,open:[0,2],optim:2,option:[0,2],order:[0,2],org:[1,2],out:1,output:[0,2],outsid:2,overload:2,page:[0,2],part:[0,1,2],passeng:[0,2],path:[0,2],perform:2,persist:2,pick:[0,2],plai:2,point:2,possibl:2,powershel:[0,2],pre:[0,2],prefer:[0,2],present:[0,2],previou:[0,2],print:[0,2],problem:2,process:2,produc:[0,2],program:[0,2],project:2,protocol:2,provid:[0,2],pub:2,publish:[0,2],pydev:[0,2],python:[0,1],queri:[0,2],question:2,queu:2,queue:2,rang:2,rather:[0,2],real:2,receiv:[0,2],recent:[0,2],releas:[0,2],reliabl:2,remix:2,replac:[0,2],replai:2,replic:2,request:[0,2],result:[0,2],retriev:[0,2],run:[0,2],sai:[0,2],same:2,sampl:[0,2],save:[0,2],search:[1,2],section:[0,2],sed:[0,2],see:[0,2],select:2,selfservic:[1,2],semant:2,send:[0,2],sent:[0,2],sep:2,server:2,set:[0,2],setup:[0,2],shell:[0,2],ship:[0,2],show:[0,2],simpl:[0,2],solut:2,solv:2,some:2,sourc:[0,2],sow:[0,2],space:[1,2],special:[0,2],sql92:2,sql:2,standard:2,start:[0,2],still:2,string:[0,2],sub:2,subscrib:[0,2],subscript:2,success:[0,2],sudo:[0,2],suggest:2,support:2,sure:[1,2],system:[0,2],take:2,taxi:[0,2],technolog:[1,2],than:[0,2],thei:2,them:[0,2],thi:[0,1,2],time:[0,2],tool:2,topic:[0,2],touch:2,track:[0,2],tradit:[0,2],transact:2,troubl:2,tune:2,two:[0,2],type:[0,2],uncompromis:2,understand:2,uniqu:[0,2],unzip:[0,2],updat:[0,2],use:[0,1,2],useful:[0,2],user:2,uses:2,using:[0,2],valu:[0,2],verifi:2,version:[0,2],view:2,virtual:[1,2],virtualbox:[1,2],visit:[1,2],vmware:[1,2],volum:2,wai:2,wait:[0,2],want:[0,2],where:[0,2],which:[0,1,2],window:[0,2],within:2,without:2,work:[0,2],write:2,xml:2,yet:[0,2],you:[0,1,2],your:[0,1,2]},titles:["Building the Client","Get the Equipment","AMPS Python Client QuickStart"],titleterms:{Going:2,Using:[0,2],amp:2,better:2,build:[0,2],client:[0,2],crank:[0,2],databas:[0,2],detect:[0,2],differ:2,equip:[1,2],faster:2,focu:[0,2],get:[1,2],keep:2,louder:2,make:2,messag:[0,2],out:[0,2],python:2,quickstart:2,state:[0,2],turn:2,welcom:2,what:2,when:[0,2],world:[0,2]}})

{amps-python-client-5.3.4.2 → amps-python-client-5.3.4.4}/docs/user-guide/html/index.html

@@ -68,7 +68,7 @@
   <div class="section" id="advanced-message-processing-system-amps-user-guide">
 <span id="ug-index"></span><h1>Advanced Message Processing System (AMPS) User Guide<a class="headerlink" href="#advanced-message-processing-system-amps-user-guide" title="Permalink to this headline">¶</a></h1>
 <p><strong>Version</strong> 5.3.4</p>
-<p><strong>Publication Date</strong> Jun 06, 2024</p>
+<p><strong>Publication Date</strong> Sep 27, 2024</p>
 <div class="toctree-wrapper compound">
 </div>
 <meta http-equiv="refresh" content="0; url=https://docs.crankuptheamps.com/"/><p>[This documentation has moved.](<a class="reference external" href="https://docs.crankuptheamps.com">https://docs.crankuptheamps.com</a>)</p>

{amps-python-client-5.3.4.2 → amps-python-client-5.3.4.4}/docs/user-guide/html/searchindex.js

@@ -1 +1 @@
-Search.setIndex({docnames:["chapters/acks","chapters/actions","chapters/amps-statistics","chapters/amps_expressions","chapters/amps_functions","chapters/auxiliary_modules","chapters/config-file-shortcuts","chapters/conflated_topics","chapters/constructing-fields","chapters/daemon","chapters/delta","chapters/distribution","chapters/enrichment","chapters/events","chapters/file_format_versions","chapters/glossary","chapters/ha","chapters/installing_and_starting","chapters/intro","chapters/logging","chapters/messageTypes","chapters/monitoring","chapters/oof","chapters/operation","chapters/pub_sub","chapters/queues","chapters/replication","chapters/securing","chapters/sow","chapters/sow_queries","chapters/spark","chapters/transports","chapters/troubleshooting","chapters/txlog","chapters/usecases","chapters/utilities","chapters/views","index"],envversion:51,filenames:["chapters/acks.rst","chapters/actions.rst","chapters/amps-statistics.rst","chapters/amps_expressions.rst","chapters/amps_functions.rst","chapters/auxiliary_modules.rst","chapters/config-file-shortcuts.rst","chapters/conflated_topics.rst","chapters/constructing-fields.rst","chapters/daemon.rst","chapters/delta.rst","chapters/distribution.rst","chapters/enrichment.rst","chapters/events.rst","chapters/file_format_versions.rst","chapters/glossary.rst","chapters/ha.rst","chapters/installing_and_starting.rst","chapters/intro.rst","chapters/logging.rst","chapters/messageTypes.rst","chapters/monitoring.rst","chapters/oof.rst","chapters/operation.rst","chapters/pub_sub.rst","chapters/queues.rst","chapters/replication.rst","chapters/securing.rst","chapters/sow.rst","chapters/sow_queries.rst","chapters/spark.rst","chapters/transports.rst","chapters/troubleshooting.rst","chapters/txlog.rst","chapters/usecases.rst","chapters/utilities.rst","chapters/views.rst","index.rst"],objects:{},objnames:{},objtypes:{},terms:{"10m":30,"case":30,"class":30,"default":30,"function":30,"public":37,"return":30,"true":30,"while":30,For:30,The:30,These:30,Use:30,With:30,abil:30,abl:30,abov:30,accept:30,ack:30,acknowledg:30,act:30,addit:30,adjust:30,all:30,allow:30,along:30,also:30,amp:30,amps_hom:30,api:30,argument:30,ask:30,attempt:30,authenticatorfactori:30,avail:30,backlog:30,backward:30,basic:30,batch:30,batchsiz:30,been:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36],befor:30,behavior:30,being:30,below:30,between:30,bin:30,bookmark:30,both:30,brief:30,cach:30,can:30,chang:30,chao:30,chapter:30,charact:30,classpath:30,client:30,code:30,com:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37],combin:30,comfort:30,commonli:30,compat:30,complet:30,compress:30,configur:30,conflat:30,connect:30,connectionrefusedexcept:30,contain:30,content:30,correlation_id:30,crankuptheamp:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37],creat:30,credenti:30,cup:30,cupboard:30,custom:30,customiz:30,data:30,databas:30,date:37,decim:30,defaultauthenticatorfactori:30,definit:30,delai:30,delet:30,delimit:30,delta:30,delta_publish:30,delta_subscrib:30,demonstr:30,depend:30,deploy:30,describ:30,descript:30,desir:30,detail:30,determin:30,differ:30,directori:30,discuss:30,disord:30,displai:30,distinct:30,doc:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,31,32,33,34,35,36,37],document:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37],doe:30,dure:30,each:30,echo:30,effect:30,either:30,enabl:30,engin:30,entir:30,error:30,everi:30,examin:30,except:30,execut:30,expect:30,expir:30,explicitli:30,express:30,factori:30,featur:30,file:30,filter:30,first:30,fix:30,flag:30,flexibl:30,follow:30,foo:30,form:30,format:30,found:30,from:30,full:30,fulli:30,gener:30,given:30,greater:30,guid:30,hand:30,has:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37],have:30,header:30,hello:30,hoc:30,host:30,how:30,http:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,31,32,33,34,35,36,37],implement:30,impli:30,improv:30,includ:30,incom:30,inde:30,indic:30,infin:30,inform:30,initi:30,input:30,insid:30,inspect:30,instal:30,instanc:30,intend:30,interact:30,interfac:30,interpret:30,jar:30,java:30,json:30,jun:37,last:30,later:30,latest:30,lease_period:30,length:30,less:30,librari:30,limit:30,line:30,list:30,listen:30,liter:30,live:30,load:30,localhost:30,locat:30,log:30,logon:30,look:30,loop:30,machin:30,mai:30,make:30,mani:30,manner:30,match:30,max_backlog:30,mention:30,messag:30,metadata:30,method:30,mix:30,more:30,most:30,move:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,31,32,33,34,35,36,37],multipl:30,must:30,name:30,necessari:30,need:30,notic:30,nvfix:30,omit:30,onc:30,one:30,onli:30,onto:30,order:30,orderbi:30,out:30,output:30,packag:30,paramet:30,particular:30,pass:30,password:30,per:30,perform:30,persist:30,pipe:30,place:30,port:30,power:30,previou:30,previous:30,print:30,process:30,product:30,prot:30,proto:30,protocol:30,provid:30,python:30,queri:30,queue:30,rang:30,rate:30,reachabl:30,read:30,real:30,receiv:30,record:30,recover:30,refer:30,regular:30,releas:30,relev:30,remov:30,replac:30,report:30,request:30,requir:30,respons:30,result:30,run:30,safe:30,same:30,scheme:30,screen:30,script:30,second:30,see:30,send:30,sent:30,separ:30,server:30,set:30,show:30,shown:30,signal:30,similar:30,simpl:30,simpli:30,sinc:30,singl:30,size:30,some:30,sow_and_delta_subscrib:30,sowkei:30,specif:30,specifi:30,standard:30,start:30,stdin:30,stdout:30,store:30,stream:30,subscript:30,succe:30,success:30,successfulli:30,support:30,sure:30,synonym:30,system:30,tag:30,tcp:30,test:30,than:30,thei:30,them:30,thi:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37],those:30,three:30,thrown:30,time:30,timestamp:30,tool:30,topic:30,topn:30,total:30,trade:30,transport:30,troubleshoot:30,type:30,unabl:30,uncompress:30,uniqu:30,unlik:30,unsuccess:30,updat:30,uri:30,usag:30,use:30,used:30,useful:30,user:30,user_id:30,usernam:30,using:30,util:30,valid:30,valu:30,variou:30,veri:30,version:37,view:30,virtual:30,wai:30,were:30,what:30,when:30,where:30,whether:30,which:30,within:30,without:30,world:30,would:30,written:30,xml:30,xpath:30,xrang:30,you:30,your:30,zip:30},titles:["17. Command Acknowledgment","24. Automating AMPS With Actions","35. The AMPS Statistics Database","4. AMPS Expressions","5. AMPS Functions","34. Auxiliary Modules","32. Configuration File Shortcuts","12. Conflated Topics","6. Constructing Fields","19. Running AMPS as a Linux Service","11. Delta Messaging","31. AMPS Distribution Layout","10. State of the World Message Enrichment","21. Event Topics","36. File Format Versions","37. Glossary of AMPS Terminology","26. Highly Available AMPS Installations","2. Installing and Starting AMPS","1. Introduction to 60East Technologies AMPS","20. Logging","16. Message Types","23. Monitoring Interface","9. Out-of-Focus Messages (OOF)","27. Operation and Deployment","3. Publish and Subscribe","15. Message Queues","25. Replicating Messages Between Instances","28. Securing AMPS","7. State of the World (SOW)","8. SOW Queries","33. Spark","18. Transports","29. Troubleshooting AMPS","14. Transactional Messaging and Bookmark Subscriptions","30. Sample Use Cases","22. Utilities","13. Aggregating and Analyzing Data in AMPS","Advanced Message Processing System (AMPS) User Guide"],titleterms:{"60east":18,"case":34,"function":4,The:2,Use:34,With:1,acknowledg:0,action:1,advanc:37,aggreg:36,amp:[1,2,3,4,9,11,15,16,17,18,27,32,36,37],analyz:36,authent:30,autom:1,auxiliari:5,avail:16,between:26,bookmark:33,command:[0,30],common:30,configur:6,conflat:7,construct:8,data:36,databas:2,delta:10,deploy:23,distribut:11,enrich:12,event:13,exampl:30,express:3,field:8,file:[6,14],focu:22,format:14,get:30,glossari:15,guid:37,help:30,highli:16,instal:[16,17],instanc:26,interfac:21,introduct:18,layout:11,linux:9,log:19,messag:[10,12,20,22,25,26,33,37],modul:5,monitor:21,oof:22,oper:23,option:30,out:22,ping:30,process:37,publish:[24,30],queri:29,queue:25,replic:26,run:9,sampl:34,secur:27,servic:9,shortcut:6,sow:[28,29,30],sow_and_subscrib:30,sow_delet:30,spark:30,start:17,state:[12,28],statist:2,subscrib:[24,30],subscript:33,system:37,technolog:18,terminolog:15,topic:[7,13],transact:33,transport:31,troubleshoot:32,type:20,user:37,util:35,version:14,world:[12,28]}})
+Search.setIndex({docnames:["chapters/acks","chapters/actions","chapters/amps-statistics","chapters/amps_expressions","chapters/amps_functions","chapters/auxiliary_modules","chapters/config-file-shortcuts","chapters/conflated_topics","chapters/constructing-fields","chapters/daemon","chapters/delta","chapters/distribution","chapters/enrichment","chapters/events","chapters/file_format_versions","chapters/glossary","chapters/ha","chapters/installing_and_starting","chapters/intro","chapters/logging","chapters/messageTypes","chapters/monitoring","chapters/oof","chapters/operation","chapters/pub_sub","chapters/queues","chapters/replication","chapters/securing","chapters/sow","chapters/sow_queries","chapters/spark","chapters/transports","chapters/troubleshooting","chapters/txlog","chapters/usecases","chapters/utilities","chapters/views","index"],envversion:51,filenames:["chapters/acks.rst","chapters/actions.rst","chapters/amps-statistics.rst","chapters/amps_expressions.rst","chapters/amps_functions.rst","chapters/auxiliary_modules.rst","chapters/config-file-shortcuts.rst","chapters/conflated_topics.rst","chapters/constructing-fields.rst","chapters/daemon.rst","chapters/delta.rst","chapters/distribution.rst","chapters/enrichment.rst","chapters/events.rst","chapters/file_format_versions.rst","chapters/glossary.rst","chapters/ha.rst","chapters/installing_and_starting.rst","chapters/intro.rst","chapters/logging.rst","chapters/messageTypes.rst","chapters/monitoring.rst","chapters/oof.rst","chapters/operation.rst","chapters/pub_sub.rst","chapters/queues.rst","chapters/replication.rst","chapters/securing.rst","chapters/sow.rst","chapters/sow_queries.rst","chapters/spark.rst","chapters/transports.rst","chapters/troubleshooting.rst","chapters/txlog.rst","chapters/usecases.rst","chapters/utilities.rst","chapters/views.rst","index.rst"],objects:{},objnames:{},objtypes:{},terms:{"10m":30,"case":30,"class":30,"default":30,"function":30,"public":37,"return":30,"true":30,"while":30,For:30,The:30,These:30,Use:30,With:30,abil:30,abl:30,abov:30,accept:30,ack:30,acknowledg:30,act:30,addit:30,adjust:30,all:30,allow:30,along:30,also:30,amp:30,amps_hom:30,api:30,argument:30,ask:30,attempt:30,authenticatorfactori:30,avail:30,backlog:30,backward:30,basic:30,batch:30,batchsiz:30,been:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36],befor:30,behavior:30,being:30,below:30,between:30,bin:30,bookmark:30,both:30,brief:30,cach:30,can:30,chang:30,chao:30,chapter:30,charact:30,classpath:30,client:30,code:30,com:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37],combin:30,comfort:30,commonli:30,compat:30,complet:30,compress:30,configur:30,conflat:30,connect:30,connectionrefusedexcept:30,contain:30,content:30,correlation_id:30,crankuptheamp:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37],creat:30,credenti:30,cup:30,cupboard:30,custom:30,customiz:30,data:30,databas:30,date:37,decim:30,defaultauthenticatorfactori:30,definit:30,delai:30,delet:30,delimit:30,delta:30,delta_publish:30,delta_subscrib:30,demonstr:30,depend:30,deploy:30,describ:30,descript:30,desir:30,detail:30,determin:30,differ:30,directori:30,discuss:30,disord:30,displai:30,distinct:30,doc:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,31,32,33,34,35,36,37],document:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37],doe:30,dure:30,each:30,echo:30,effect:30,either:30,enabl:30,engin:30,entir:30,error:30,everi:30,examin:30,except:30,execut:30,expect:30,expir:30,explicitli:30,express:30,factori:30,featur:30,file:30,filter:30,first:30,fix:30,flag:30,flexibl:30,follow:30,foo:30,form:30,format:30,found:30,from:30,full:30,fulli:30,gener:30,given:30,greater:30,guid:30,hand:30,has:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37],have:30,header:30,hello:30,hoc:30,host:30,how:30,http:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,31,32,33,34,35,36,37],implement:30,impli:30,improv:30,includ:30,incom:30,inde:30,indic:30,infin:30,inform:30,initi:30,input:30,insid:30,inspect:30,instal:30,instanc:30,intend:30,interact:30,interfac:30,interpret:30,jar:30,java:30,json:30,last:30,later:30,latest:30,lease_period:30,length:30,less:30,librari:30,limit:30,line:30,list:30,listen:30,liter:30,live:30,load:30,localhost:30,locat:30,log:30,logon:30,look:30,loop:30,machin:30,mai:30,make:30,mani:30,manner:30,match:30,max_backlog:30,mention:30,messag:30,metadata:30,method:30,mix:30,more:30,most:30,move:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,31,32,33,34,35,36,37],multipl:30,must:30,name:30,necessari:30,need:30,notic:30,nvfix:30,omit:30,onc:30,one:30,onli:30,onto:30,order:30,orderbi:30,out:30,output:30,packag:30,paramet:30,particular:30,pass:30,password:30,per:30,perform:30,persist:30,pipe:30,place:30,port:30,power:30,previou:30,previous:30,print:30,process:30,product:30,prot:30,proto:30,protocol:30,provid:30,python:30,queri:30,queue:30,rang:30,rate:30,reachabl:30,read:30,real:30,receiv:30,record:30,recover:30,refer:30,regular:30,releas:30,relev:30,remov:30,replac:30,report:30,request:30,requir:30,respons:30,result:30,run:30,safe:30,same:30,scheme:30,screen:30,script:30,second:30,see:30,send:30,sent:30,sep:37,separ:30,server:30,set:30,show:30,shown:30,signal:30,similar:30,simpl:30,simpli:30,sinc:30,singl:30,size:30,some:30,sow_and_delta_subscrib:30,sowkei:30,specif:30,specifi:30,standard:30,start:30,stdin:30,stdout:30,store:30,stream:30,subscript:30,succe:30,success:30,successfulli:30,support:30,sure:30,synonym:30,system:30,tag:30,tcp:30,test:30,than:30,thei:30,them:30,thi:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37],those:30,three:30,thrown:30,time:30,timestamp:30,tool:30,topic:30,topn:30,total:30,trade:30,transport:30,troubleshoot:30,type:30,unabl:30,uncompress:30,uniqu:30,unlik:30,unsuccess:30,updat:30,uri:30,usag:30,use:30,used:30,useful:30,user:30,user_id:30,usernam:30,using:30,util:30,valid:30,valu:30,variou:30,veri:30,version:37,view:30,virtual:30,wai:30,were:30,what:30,when:30,where:30,whether:30,which:30,within:30,without:30,world:30,would:30,written:30,xml:30,xpath:30,xrang:30,you:30,your:30,zip:30},titles:["17. Command Acknowledgment","24. Automating AMPS With Actions","35. The AMPS Statistics Database","4. AMPS Expressions","5. AMPS Functions","34. Auxiliary Modules","32. Configuration File Shortcuts","12. Conflated Topics","6. Constructing Fields","19. Running AMPS as a Linux Service","11. Delta Messaging","31. AMPS Distribution Layout","10. State of the World Message Enrichment","21. Event Topics","36. File Format Versions","37. Glossary of AMPS Terminology","26. Highly Available AMPS Installations","2. Installing and Starting AMPS","1. Introduction to 60East Technologies AMPS","20. Logging","16. Message Types","23. Monitoring Interface","9. Out-of-Focus Messages (OOF)","27. Operation and Deployment","3. Publish and Subscribe","15. Message Queues","25. Replicating Messages Between Instances","28. Securing AMPS","7. State of the World (SOW)","8. SOW Queries","33. Spark","18. Transports","29. Troubleshooting AMPS","14. Transactional Messaging and Bookmark Subscriptions","30. Sample Use Cases","22. Utilities","13. Aggregating and Analyzing Data in AMPS","Advanced Message Processing System (AMPS) User Guide"],titleterms:{"60east":18,"case":34,"function":4,The:2,Use:34,With:1,acknowledg:0,action:1,advanc:37,aggreg:36,amp:[1,2,3,4,9,11,15,16,17,18,27,32,36,37],analyz:36,authent:30,autom:1,auxiliari:5,avail:16,between:26,bookmark:33,command:[0,30],common:30,configur:6,conflat:7,construct:8,data:36,databas:2,delta:10,deploy:23,distribut:11,enrich:12,event:13,exampl:30,express:3,field:8,file:[6,14],focu:22,format:14,get:30,glossari:15,guid:37,help:30,highli:16,instal:[16,17],instanc:26,interfac:21,introduct:18,layout:11,linux:9,log:19,messag:[10,12,20,22,25,26,33,37],modul:5,monitor:21,oof:22,oper:23,option:30,out:22,ping:30,process:37,publish:[24,30],queri:29,queue:25,replic:26,run:9,sampl:34,secur:27,servic:9,shortcut:6,sow:[28,29,30],sow_and_subscrib:30,sow_delet:30,spark:30,start:17,state:[12,28],statist:2,subscrib:[24,30],subscript:33,system:37,technolog:18,terminolog:15,topic:[7,13],transact:33,transport:31,troubleshoot:32,type:20,user:37,util:35,version:14,world:[12,28]}})

{amps-python-client-5.3.4.2 → amps-python-client-5.3.4.4}/include/ampspy_defs.hpp

@@ -35,6 +35,7 @@
 #include <amps/ReconnectDelayStrategy.hpp>
 #include <amps/CompositeMessageBuilder.hpp>
 #include <amps/CompositeMessageParser.hpp>
+#include <amps/amps_ssl.h>
 #include <vector>
 #include <deque>
 
@@ -139,7 +140,16 @@ namespace ampspy
 
   extern bool _is_signaled;
 
-  AMPSDLL PyObject* ssl_init_internal(const char*);
+#if PY_MAJOR_VERSION >= 3
+  AMPSDLL PyObject* ampspy_ssl_init(PyObject* self, PyObject* args, PyObject* kwds = NULL);
+  AMPSDLL PyObject* ssl_init(PyObject* self, PyObject* args, PyObject* kwds = NULL);
+  AMPSDLL PyObject* ssl_init_internal(const char*, PyObject*, bool strictCiphersOnly = false);
+
+  AMPSDLL PyObject* ampspy_get_PySSLSocket_from_SSL(_amps_SSL* ssl_);
+#else
+  AMPSDLL PyObject* ampspy_ssl_init(PyObject* self, PyObject* args);
+  AMPSDLL PyObject* ssl_init(PyObject* self, PyObject* args);
+#endif
 
 // conversions from c++ types
   inline PyObject* ret(const char* returnValue)

amps-python-client-5.3.4.4/include/ampspy_ssl.hpp

@@ -0,0 +1,31 @@
+////////////////////////////////////////////////////////////////////////////
+//
+// Copyright (c) 2010-2024 60East Technologies Inc., All Rights Reserved.
+//
+// This computer software is owned by 60East Technologies Inc. and is
+// protected by U.S. copyright laws and other laws and by international
+// treaties.  This computer software is furnished by 60East Technologies
+// Inc. pursuant to a written license agreement and may be used, copied,
+// transmitted, and stored only in accordance with the terms of such
+// license agreement and with the inclusion of the above copyright notice.
+// This computer software or any other copies thereof may not be provided
+// or otherwise made available to any other person.
+//
+// U.S. Government Restricted Rights.  This computer software: (a) was
+// developed at private expense and is in all respects the proprietary
+// information of 60East Technologies Inc.; (b) was not developed with
+// government funds; (c) is a trade secret of 60East Technologies Inc.
+// for all purposes of the Freedom of Information Act; and (d) is a
+// commercial item and thus, pursuant to Section 12.212 of the Federal
+// Acquisition Regulations (FAR) and DFAR Supplement Section 227.7202,
+// Government's use, duplication or disclosure of the computer software
+// is subject to the restrictions set forth by 60East Technologies Inc..
+//
+////////////////////////////////////////////////////////////////////////////
+#ifndef __AMPSPY_SSL_HPP
+#define __AMPSPY_SSL_HPP
+#include <amps/amps.h>
+namespace ampspy {
+    AMPSDLL void _ampspy_ssl_cleanup(void);
+}
+#endif //__AMPSPY_SSL_HPP

{amps-python-client-5.3.4.2 → amps-python-client-5.3.4.4}/include/ampspyver.h

@@ -25,6 +25,6 @@
 #ifndef _AMPSPYVER_H_
 #define _AMPSPYVER_H_
 
-const char* AMPS_PYTHON_VERSION = "5.3.4.2.3304e34.540236";
+const char* AMPS_PYTHON_VERSION = "5.3.4.4.1b5ff54.964735";
 
 #endif //_AMPSPYVER_H_

{amps-python-client-5.3.4.2 → amps-python-client-5.3.4.4}/index.html

@@ -34,7 +34,7 @@
         <div id="banner">
             <a href="http://documentation.crankuptheamps.com/"><img id="logo" src="./docs/resources/flag_logo.svg" alt="60East flags"/></a>
             <h1>AMPS Python Client Resources</h1>
-            <h3>Version: 5.3.4.2</h3>
+            <h3>Version: 5.3.4.4</h3>
         </div>
 
         <div class="divider"></div>

{amps-python-client-5.3.4.2 → amps-python-client-5.3.4.4}/setup.py

@@ -13,8 +13,8 @@
 ## or otherwise made available to any other person.
 ##
 ## U.S. Government Restricted Rights.  This computer software: (a) was
-## 5.3.4.2ed at private expense and is in all respects the proprietary
-## information of 60East Technologies Inc.; (b) was not 5.3.4.2ed with
+## 5.3.4.4ed at private expense and is in all respects the proprietary
+## information of 60East Technologies Inc.; (b) was not 5.3.4.4ed with
 ## government funds; (c) is a trade secret of 60East Technologies Inc.
 ## for all purposes of the Freedom of Information Act; and (d) is a
 ## commercial item and thus, pursuant to Section 12.212 of the Federal
@@ -89,7 +89,7 @@ amps_client_sources=glob.glob(os.path.join(amps_cpp_dir, 'src','*.c'))
 libraries_list = []
 extra_args = []
 link_args = []
-PY_LIMITED_API_version = "Py_LIMITED_API=0x03040000"
+PY_LIMITED_API_version = "Py_LIMITED_API=0x03060000"
 if sys.platform != "win32":
     libraries_list.append("amps")
     if sys.platform[:5] == "linux":
@@ -173,7 +173,7 @@ AMPSModule = Extension('AMPS',
 AMPSModule.py_limited_api = True
 
 # Will be replaced with the actual version number by build.xml
-module_version="5.3.4.2"
+module_version="5.3.4.4"
 
 if module_version.startswith('@'):
     # Running this on a bare repository or source tree; try finding the branch name.
@@ -182,7 +182,7 @@ if module_version.startswith('@'):
         process = subprocess.Popen(["git","rev-parse","--abbrev-ref","HEAD"],stdin=subprocess.PIPE,stdout=subprocess.PIPE,stderr=subprocess.PIPE)
         result = process.communicate()
         module_version = result[0].decode('utf-8').strip()
-        if module_version == "5.3.4.2" or module_version[:5] == "auto-":
+        if module_version == "5.3.4.4" or module_version[:5] == "auto-":
             module_version = "99.99.99.99"
         print("VERSION %s"%module_version)
     except:

{amps-python-client-5.3.4.2 → amps-python-client-5.3.4.4}/setup_amps.py

@@ -13,8 +13,8 @@
 ## or otherwise made available to any other person.
 ##
 ## U.S. Government Restricted Rights.  This computer software: (a) was
-## 5.3.4.2ed at private expense and is in all respects the proprietary
-## information of 60East Technologies Inc.; (b) was not 5.3.4.2ed with
+## 5.3.4.4ed at private expense and is in all respects the proprietary
+## information of 60East Technologies Inc.; (b) was not 5.3.4.4ed with
 ## government funds; (c) is a trade secret of 60East Technologies Inc.
 ## for all purposes of the Freedom of Information Act; and (d) is a
 ## commercial item and thus, pursuant to Section 12.212 of the Federal
@@ -61,7 +61,15 @@ amps_client_sources=glob.glob(os.path.join(amps_cpp_dir, 'src','*.c'))
 
 if sys.platform != "win32":
     if os.path.exists('src/cpp/lib/libamps.a'):
-        sys.exit(0)
+        build = False
+        last_build_time = os.path.getmtime('src/cpp/lib/libamps.a')
+        for src in amps_client_sources:
+            build = build | (os.path.getmtime(src) >= last_build_time)
+        if not build:
+            for header in glob.glob(os.path.join(amps_cpp_dir, 'include', 'amps', '*.h*')):
+                build = build | (os.path.getmtime(header) >= last_build_time)
+            if not build:
+              sys.exit(0)
     import subprocess
     f = open("foo.c", "w+")
     f.write("#include <stdatomic.h>");
@@ -84,7 +92,7 @@ elif "shared" in sys.argv or "AMPS_SHARED" in os.environ:
 
 setup(name='amps-c-client',
       description='AMPS C Client',
-      version='5.3.4.2',
+      version='5.3.4.4',
       maintainer='60East Technologies, Incorporated',
       maintainer_email='support@crankuptheamps.com',
       url='https://crankuptheamps.com',

{amps-python-client-5.3.4.2 → amps-python-client-5.3.4.4}/src/ampspy_shims.cpp

@@ -23,6 +23,7 @@
 //
 ////////////////////////////////////////////////////////////////////////////
 #include <ampspy_shims.hpp>
+#include <ampspy_ssl.hpp>
 
 #ifdef _WIN32
   #include <Windows.h>
@@ -73,6 +74,7 @@ namespace ampspy
     }
     PyObject* _shimExitFunc(void)
     {
+      _ampspy_ssl_cleanup();
       Py_INCREF(Py_None);
       return Py_None;
     }
@@ -185,19 +187,27 @@ namespace ampspy
       {
         ampspy::shims::Py_IsFinalizing = &ampspy36IsFinalizing;
       }
-      else if (!getSymbol("_Py_IsFinalizing", &ampspy::shims::Py_IsFinalizing))
+      else if (!getSymbol("_Py_IsFinalizing", &ampspy::shims::Py_IsFinalizing)
+               && !getSymbol("Py_IsFinalizing", &ampspy::shims::Py_IsFinalizing))
       {
-        // Python 3.7+: use _Py_IsFinalizing function
+        // Python 3.7 - 3.12: use _Py_IsFinalizing function
+        // Python 3.13+: use Py_IsFinalizing function
         PyErr_SetString(PyExc_RuntimeError,
-                        "Error locating _Py_Finalizing or _Py_IsFinalizing; cannot load AMPS.");
+                        "Error locating _Py_Finalizing, _Py_IsFinalizing, or"
+                        " Py_IsFinalizing; cannot load AMPS.");
         return false;
       }
 
+      // Python 3.6 - 3.12: use _Py_UncheckedGet function
+      // Python 3.13+: use Py_GetUnchecked function
       if (!getSymbol("_PyThreadState_UncheckedGet",
-                     &ampspy::shims::PyThreadState_UncheckedGet))
+                     &ampspy::shims::PyThreadState_UncheckedGet)
+          && !getSymbol("PyThreadState_GetUnchecked",
+                        &ampspy::shims::PyThreadState_UncheckedGet))
       {
         PyErr_SetString(PyExc_RuntimeError,
-                        "Error locating _PyThreadState_UncheckedGet; cannot load AMPS.");
+                        "Error locating _PyThreadState_UncheckedGet or"
+                        " PyThreadState_GetUnchecked; cannot load AMPS.");
         return false;
       }
       if (!getSymbol("PyUnicode_AsUTF8AndSize",

{amps-python-client-5.3.4.2 → amps-python-client-5.3.4.4}/src/client.cpp

@@ -378,6 +378,9 @@ namespace ampspy
         }
         delete pCallbackInfos;
       }
+      Py_CLEAR(self->threadCreatedCallback);
+      Py_CLEAR(self->message_args);
+      Py_CLEAR(self->message);
     }
 
     AMPSDLL void destructor(PyObject* self_)
@@ -535,7 +538,7 @@ namespace ampspy
       if (strlen(uri) > 3 && uri[0] == 't' && uri[1] == 'c' && uri[2] == 'p'
           && uri[3] == 's')
       {
-        PyObject* initResult = ssl_init_internal(NULL);
+        PyObject* initResult = ampspy_ssl_init(NULL, NULL);
         if (initResult == NULL)
         {
           return NULL;
@@ -2434,6 +2437,22 @@ namespace ampspy
                               msgHandler));
     }
 
+#if PY_MAJOR_VERSION >= 3
+//    def get_ssl(self)
+    static PyObject* get_ssl(obj* self, PyObject* args)
+    {
+      _amps_SSL* ssl = NULL;
+      {
+        UNLOCKGIL;
+        if (((AMPS::Client*)(self->pClient))->getURI().find("tcps") != std::string::npos)
+        {
+          ssl = (void*)(amps_tcps_get_SSL(amps_client_get_transport(((AMPS::Client*)(self->pClient))->getHandle())));
+        }
+      }
+      return ampspy_get_PySSLSocket_from_SSL(ssl);
+    }
+#endif
+
 ///
 /// This method is used by python internals for garbage collection.
 ///
@@ -2635,6 +2654,10 @@ namespace ampspy
       .addKeywordMethod("set_global_command_type_message_handler",
                         set_global_command_type_message_handler,
                         set_global_command_type_message_handler_doc)
+#if PY_MAJOR_VERSION >= 3
+      .addMethod("get_ssl", get_ssl,
+                 "For a tcps client, returns the PySSLSocket of the connection")
+#endif
       .addGetter("_as_parameter_", (void*)get_as_parameter,
                  "Underlying Client pointer for use with foreign functions and the ctypes module.")
       .createType()