11<!DOCTYPE html>
2- < html class ="writer-html5 " lang ="en " >
2+ < html class ="writer-html5 " lang ="en " data-content_root =" ../../ " >
33< head >
44 < meta charset ="utf-8 " />
55 < meta name ="viewport " content ="width=device-width, initial-scale=1.0 " />
6- < title > sttp.config — sttp/pyapi 0.6.0 documentation</ title >
7- < link rel ="stylesheet " href ="../../_static/pygments.css " type ="text/css " />
8- < link rel ="stylesheet " href ="../../_static/css/theme.css " type ="text/css " />
6+ < title > sttp.config — sttp/pyapi 0.6.2 documentation</ title >
7+ < link rel ="stylesheet " type ="text/css " href ="../../_static/pygments.css?v=92fd9be5 " />
8+ < link rel ="stylesheet " type ="text/css " href ="../../_static/css/theme.css?v=8209df7b " />
9+
10+
911 < link rel ="shortcut icon " href ="https://raw.githubusercontent.com/sttp/pyapi/main/docs/img/favicon.ico "/>
1012 <!--[if lt IE 9]>
1113 <script src="../../_static/js/html5shiv.min.js"></script>
1214 <![endif]-->
1315
14- < script data-url_root =" ../../ " id =" documentation_options " src ="../../_static/documentation_options .js "> </ script >
15- < script src ="../../_static/jquery .js "> </ script >
16- < script src ="../../_static/underscore .js "> </ script >
17- < script src ="../../_static/_sphinx_javascript_frameworks_compat .js "> </ script >
18- < script src ="../../_static/doctools .js "> </ script >
16+ < script src ="../../_static/jquery .js?v=5d32c60e "> </ script >
17+ < script src ="../../_static/_sphinx_javascript_frameworks_compat .js?v=bbec6902 "> </ script >
18+ < script src ="../../_static/documentation_options .js?v=b1f64a84 "> </ script >
19+ < script src ="../../_static/doctools .js?v=92e14aea "> </ script >
20+ < script src ="../../_static/sphinx_highlight .js?v=dc90522c "> </ script >
1921 < script src ="../../_static/js/theme.js "> </ script >
2022 < link rel ="index " title ="Index " href ="../../genindex.html " />
2123 < link rel ="search " title ="Search " href ="../../search.html " />
2628 < nav data-toggle ="wy-nav-shift " class ="wy-nav-side ">
2729 < div class ="wy-side-scroll ">
2830 < div class ="wy-side-nav-search " >
29- < a href ="../../index.html " class ="icon icon-home "> sttp/pyapi
30- < img src ="https://raw.githubusercontent.com/sttp/pyapi/main/docs/img/sttp.png " class ="logo " alt ="Logo "/>
31+
32+
33+
34+ < a href ="../../index.html " class ="icon icon-home ">
35+ sttp/pyapi
36+ < img src ="https://raw.githubusercontent.com/sttp/pyapi/main/docs/img/sttp.png " class ="logo " alt ="Logo "/>
3137 </ a >
3238< div role ="search ">
3339 < form id ="rtd-search-form " class ="wy-form " action ="../../search.html " method ="get ">
34- < input type ="text " name ="q " placeholder ="Search docs " />
40+ < input type ="text " name ="q " placeholder ="Search docs " aria-label =" Search docs " />
3541 < input type ="hidden " name ="check_keywords " value ="yes " />
3642 < input type ="hidden " name ="area " value ="default " />
3743 </ form >
5258 < div class ="rst-content ">
5359 < div role ="navigation " aria-label ="Page navigation ">
5460 < ul class ="wy-breadcrumbs ">
55- < li > < a href ="../../index.html " class ="icon icon-home "> </ a > » </ li >
56- < li > < a href ="../index.html "> Module code</ a > » </ li >
57- < li > sttp.config</ li >
61+ < li > < a href ="../../index.html " class ="icon icon-home " aria-label =" Home " > </ a > </ li >
62+ < li class =" breadcrumb-item " > < a href ="../index.html "> Module code</ a > </ li >
63+ < li class =" breadcrumb-item active " > sttp.config</ li >
5864 < li class ="wy-breadcrumbs-aside ">
5965 </ li >
6066 </ ul >
@@ -90,8 +96,10 @@ <h1>Source code for sttp.config</h1><div class="highlight"><pre>
9096< span class ="kn "> from</ span > < span class ="nn "> .transport.constants</ span > < span class ="kn "> import</ span > < span class ="n "> Defaults</ span >
9197< span class ="kn "> import</ span > < span class ="nn "> numpy</ span > < span class ="k "> as</ span > < span class ="nn "> np</ span >
9298
93- < div class ="viewcode-block " id ="Config "> < a class ="viewcode-back " href ="../../sttp.html#sttp.config.Config "> [docs]</ a > < span class ="k "> class</ span > < span class ="nc "> Config</ span > < span class ="p "> :</ span >
94- < span class ="sd "> """</ span >
99+ < div class ="viewcode-block " id ="Config ">
100+ < a class ="viewcode-back " href ="../../sttp.html#sttp.config.Config "> [docs]</ a >
101+ < span class ="k "> class</ span > < span class ="nc "> Config</ span > < span class ="p "> :</ span >
102+ < span class ="w "> </ span > < span class ="sd "> """</ span >
95103< span class ="sd "> Defines the STTP connection related configuration parameters.</ span >
96104< span class ="sd "> """</ span >
97105
@@ -122,41 +130,41 @@ <h1>Source code for sttp.config</h1><div class="highlight"><pre>
122130 < span class ="n "> socket_timeout</ span > < span class ="p "> :</ span > < span class ="nb "> float</ span > < span class ="o "> =</ span > < span class ="o "> ...</ span > < span class ="p "> ,</ span >
123131 < span class ="n "> version</ span > < span class ="p "> :</ span > < span class ="n "> np</ span > < span class ="o "> .</ span > < span class ="n "> byte</ span > < span class ="o "> =</ span > < span class ="o "> ...</ span >
124132 < span class ="p "> ):</ span >
125- < span class ="sd "> """</ span >
133+ < span class =" w " > </ span > < span class ="sd "> """</ span >
126134< span class ="sd "> Creates a new `Config` instance.</ span >
127135< span class ="sd "> """</ span >
128136
129137 < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> maxretries</ span > < span class ="o "> =</ span > < span class ="n "> Config</ span > < span class ="o "> .</ span > < span class ="n "> DEFAULT_MAXRETRIES</ span > < span class ="k "> if</ span > < span class ="n "> maxretries</ span > < span class ="ow "> is</ span > < span class ="o "> ...</ span > < span class ="k "> else</ span > < span class ="n "> maxretries</ span >
130- < span class ="sd "> """</ span >
138+ < span class =" w " > </ span > < span class ="sd "> """</ span >
131139< span class ="sd "> Defines the maximum number of times to retry a connection.</ span >
132140< span class ="sd "> Set value to -1 to retry infinitely.</ span >
133141< span class ="sd "> """</ span >
134142
135143 < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> retryinterval</ span > < span class ="o "> =</ span > < span class ="n "> Config</ span > < span class ="o "> .</ span > < span class ="n "> DEFAULT_RETRYINTERVAL</ span > < span class ="k "> if</ span > < span class ="n "> retryinterval</ span > < span class ="ow "> is</ span > < span class ="o "> ...</ span > < span class ="k "> else</ span > < span class ="n "> retryinterval</ span >
136- < span class ="sd "> """</ span >
144+ < span class =" w " > </ span > < span class ="sd "> """</ span >
137145< span class ="sd "> Defines the base retry interval, in seconds. Retries will exponentially back-off</ span >
138146< span class ="sd "> starting from this interval.</ span >
139147< span class ="sd "> """</ span >
140148
141149 < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> maxretryinterval</ span > < span class ="o "> =</ span > < span class ="n "> Config</ span > < span class ="o "> .</ span > < span class ="n "> DEFAULT_MAXRETRYINTERVAL</ span > < span class ="k "> if</ span > < span class ="n "> maxretryinterval</ span > < span class ="ow "> is</ span > < span class ="o "> ...</ span > < span class ="k "> else</ span > < span class ="n "> maxretryinterval</ span >
142- < span class ="sd "> """</ span >
150+ < span class =" w " > </ span > < span class ="sd "> """</ span >
143151< span class ="sd "> Defines the maximum retry interval, in seconds.</ span >
144152< span class ="sd "> """</ span >
145153
146154 < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> autoreconnect</ span > < span class ="o "> =</ span > < span class ="n "> Config</ span > < span class ="o "> .</ span > < span class ="n "> DEFAULT_AUTORECONNECT</ span > < span class ="k "> if</ span > < span class ="n "> autoreconnect</ span > < span class ="ow "> is</ span > < span class ="o "> ...</ span > < span class ="k "> else</ span > < span class ="n "> autoreconnect</ span >
147- < span class ="sd "> """</ span >
155+ < span class =" w " > </ span > < span class ="sd "> """</ span >
148156< span class ="sd "> Defines flag that determines if connections should be automatically reattempted.</ span >
149157< span class ="sd "> """</ span >
150158
151159 < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> autorequestmetadata</ span > < span class ="o "> =</ span > < span class ="n "> Config</ span > < span class ="o "> .</ span > < span class ="n "> DEFAULT_AUTOREQUESTMETADATA</ span > < span class ="k "> if</ span > < span class ="n "> autorequestmetadata</ span > < span class ="ow "> is</ span > < span class ="o "> ...</ span > < span class ="k "> else</ span > < span class ="n "> autorequestmetadata</ span >
152- < span class ="sd "> """</ span >
160+ < span class =" w " > </ span > < span class ="sd "> """</ span >
153161< span class ="sd "> Defines the flag that determines if metadata should be automatically requested</ span >
154162< span class ="sd "> upon successful connection. When True, metadata will be requested upon connection</ span >
155163< span class ="sd "> before subscription; otherwise, any metadata operations must be handled manually.</ span >
156164< span class ="sd "> """</ span >
157165
158166 < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> autosubscribe</ span > < span class ="o "> =</ span > < span class ="n "> Config</ span > < span class ="o "> .</ span > < span class ="n "> DEFAULT_AUTOSUBSCRIBE</ span > < span class ="k "> if</ span > < span class ="n "> autosubscribe</ span > < span class ="ow "> is</ span > < span class ="o "> ...</ span > < span class ="k "> else</ span > < span class ="n "> autosubscribe</ span >
159- < span class ="sd "> """</ span >
167+ < span class =" w " > </ span > < span class ="sd "> """</ span >
160168< span class ="sd "> Defines the flag that determines if subscription should be handled automatically</ span >
161169< span class ="sd "> upon successful connection. When `autorequestmetadata` is True and</ span >
162170< span class ="sd "> `autosubscribe` is True, subscription will occur after reception of metadata.</ span >
@@ -166,35 +174,36 @@ <h1>Source code for sttp.config</h1><div class="highlight"><pre>
166174< span class ="sd "> """</ span >
167175
168176 < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> compress_payloaddata</ span > < span class ="o "> =</ span > < span class ="n "> Config</ span > < span class ="o "> .</ span > < span class ="n "> DEFAULT_COMPRESS_PAYLOADDATA</ span > < span class ="k "> if</ span > < span class ="n "> compress_payloaddata</ span > < span class ="ow "> is</ span > < span class ="o "> ...</ span > < span class ="k "> else</ span > < span class ="n "> compress_payloaddata</ span >
169- < span class ="sd "> """</ span >
177+ < span class =" w " > </ span > < span class ="sd "> """</ span >
170178< span class ="sd "> Determines whether payload data is compressed.</ span >
171179< span class ="sd "> """</ span >
172180
173181 < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> compress_metadata</ span > < span class ="o "> =</ span > < span class ="n "> Config</ span > < span class ="o "> .</ span > < span class ="n "> DEFAULT_COMPRESS_METADATA</ span > < span class ="k "> if</ span > < span class ="n "> compress_metadata</ span > < span class ="ow "> is</ span > < span class ="o "> ...</ span > < span class ="k "> else</ span > < span class ="n "> compress_metadata</ span >
174- < span class ="sd "> """</ span >
182+ < span class =" w " > </ span > < span class ="sd "> """</ span >
175183< span class ="sd "> Determines whether the metadata transfer is compressed.</ span >
176184< span class ="sd "> """</ span >
177185
178186 < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> compress_signalindexcache</ span > < span class ="o "> =</ span > < span class ="n "> Config</ span > < span class ="o "> .</ span > < span class ="n "> DEFAULT_COMPRESS_SIGNALINDEXCACHE</ span > < span class ="k "> if</ span > < span class ="n "> compress_signalindexcache</ span > < span class ="ow "> is</ span > < span class ="o "> ...</ span > < span class ="k "> else</ span > < span class ="n "> compress_signalindexcache</ span >
179- < span class ="sd "> """</ span >
187+ < span class =" w " > </ span > < span class ="sd "> """</ span >
180188< span class ="sd "> Determines whether the signal index cache is compressed.</ span >
181189< span class ="sd "> """</ span >
182190
183191 < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> metadatafilters</ span > < span class ="o "> =</ span > < span class ="n "> Config</ span > < span class ="o "> .</ span > < span class ="n "> DEFAULT_METADATAFILTERS</ span > < span class ="k "> if</ span > < span class ="n "> metadatafilters</ span > < span class ="ow "> is</ span > < span class ="o "> ...</ span > < span class ="k "> else</ span > < span class ="n "> metadatafilters</ span >
184- < span class ="sd "> """</ span >
192+ < span class =" w " > </ span > < span class ="sd "> """</ span >
185193< span class ="sd "> Defines any filters to be applied to incoming metadata to reduce total received metadata.</ span >
186194< span class ="sd "> Each filter expression should be separated by semi-colon.</ span >
187195< span class ="sd "> """</ span >
188196
189197 < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> socket_timeout</ span > < span class ="o "> =</ span > < span class ="n "> Config</ span > < span class ="o "> .</ span > < span class ="n "> DEFAULT_SOCKET_TIMEOUT</ span > < span class ="k "> if</ span > < span class ="n "> socket_timeout</ span > < span class ="ow "> is</ span > < span class ="o "> ...</ span > < span class ="k "> else</ span > < span class ="n "> socket_timeout</ span >
190- < span class ="sd "> """</ span >
198+ < span class =" w " > </ span > < span class ="sd "> """</ span >
191199< span class ="sd "> Defines the timeout in seconds for all socket connections.</ span >
192200< span class ="sd "> """</ span >
193201
194202 < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> version</ span > < span class ="o "> =</ span > < span class ="n "> Config</ span > < span class ="o "> .</ span > < span class ="n "> DEFAULT_VERSION</ span > < span class ="k "> if</ span > < span class ="n "> version</ span > < span class ="ow "> is</ span > < span class ="o "> ...</ span > < span class ="k "> else</ span > < span class ="n "> version</ span >
195- < span class ="sd "> """</ span >
203+ < span class =" w " > </ span > < span class ="sd "> """</ span >
196204< span class ="sd "> Defines the target STTP protocol version. This currently defaults to 2.</ span >
197205< span class ="sd "> """</ span > </ div >
206+
198207</ pre > </ div >
199208
200209 </ div >
@@ -216,7 +225,9 @@ <h1>Source code for sttp.config</h1><div class="highlight"><pre>
216225< p >
217226 < a href ="https://github.com/sttp/pyapi "> GitHub Home</ a >
218227 •
219- < a href ="https://pypi.org/project/sttpapi/ "> PyPi Package: sttpapi</ a >
228+ < a href ="https://pypi.org/project/sttpapi/ " target ="_blank "> PyPi Package: sttpapi</ a >
229+ •
230+ < a href ="https://sttp.github.io/documentation/ " target ="_blank "> General STTP Documentation</ a >
220231</ p >
221232< br /> < br />
222233Copyright © 2022, < a href ="https://gridprotectionalliance.org/ " target ="_blank "> Grid Protection Alliance</ a >
0 commit comments