-
Notifications
You must be signed in to change notification settings - Fork 0
/
zfputil.py
109 lines (84 loc) · 3.72 KB
/
zfputil.py
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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
# zfputil.py
"""Provide utilities designed for the Zero Footprint solution clients that
leverage private leased lines to the Bloomberg network.
This file defines a 'ZfpUtil' class which is used to prepare session options
for private leased lines.
Usage
----
The following snippet shows how to use ZfpUtil to start a Session.
tlsOptions = blpapi.TlsOptions.createFromFiles( ... )
sessionOptions = blpapi.ZfpUtil.getZfpOptionsForLeasedLines(
blpapi.ZfpUtil.REMOTE_8194,
tlsOptions)
sessionOptions.setAuthenticationOptions( ... )
session = blpapi.Session(sessionOptions)
session.start()
"""
from . import utils
from . import internals
from . import typehints # pylint: disable=unused-import
from .exception import _ExceptionUtil
from .sessionoptions import SessionOptions
# pylint: disable=too-few-public-methods
class ZfpUtil(metaclass=utils.MetaClassForClassesWithEnums):
"""Utility used to prepare :class:`SessionOptions` for private leased
lines.
The following snippet shows how to use :class:`ZfpUtil` to start a
``Session``::
tlsOptions = blpapi.TlsOptions.createFromFiles( ... )
sessionOptions = blpapi.ZfpUtil.getZfpOptionsForLeasedLines(
blpapi.ZfpUtil.REMOTE_8194,
tlsOptions)
sessionOptions.setAuthenticationOptions( ... )
session = blpapi.Session(sessionOptions)
session.start()
"""
REMOTE_8194 = internals.ZFPUTIL_REMOTE_8194
REMOTE_8196 = internals.ZFPUTIL_REMOTE_8196
@staticmethod
def getZfpOptionsForLeasedLines(
remote: int, tlsOptions: "typehints.TlsOptions"
) -> "typehints.SessionOptions":
"""Creates a :class:`SessionOptions` object for applications that
leverage private leased lines to the Bloomberg network.
Args:
remote (int): Type of the remote to connect to
tlsOptions (TlsOptions): Tls options to use when connecting
Returns:
SessionOptions: :class:`SessionOptions` object for applications
that leverage private leased lines to the Bloomberg network.
Raises:
Exception: If failed to obtain the session options
Note:
The :class:`SessionOptions` object is only valid for private leased
line connectivity.
Note:
This is a costly operation that is preferably called once per
application.
"""
sessionOptions = SessionOptions()
err = internals.blpapi_ZfpUtil_getOptionsForLeasedLines(
utils.get_handle(sessionOptions),
utils.get_handle(tlsOptions),
remote,
)
_ExceptionUtil.raiseOnError(err)
return sessionOptions
__copyright__ = """
Copyright 2019. Bloomberg Finance L.P.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to
deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions: The above
copyright notice and this permission notice shall be included in all copies
or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN THE SOFTWARE.
"""