libe3py 0.2.7__tar.gz → 0.2.8__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: libe3py
3
- Version: 0.2.7
3
+ Version: 0.2.8
4
4
  Summary: Python binding of libe3, the O-RAN E3 interface library
5
5
  Author: Northeastern University
6
6
  License-Expression: Apache-2.0
libe3py-0.2.8/VERSION ADDED
@@ -0,0 +1 @@
1
+ 0.2.8
@@ -14,7 +14,7 @@
14
14
  * @ref libe3::py::DAppSession is the answer: it owns an @ref libe3::E3Agent in
15
15
  * DAPP role, registers the C++ handlers itself, and funnels every inbound
16
16
  * message into a **bounded lock-free ring** (@ref libe3::LockFreeQueue). Python
17
- * drains that ring in **batches** via @ref poll_events, so one GIL acquire and
17
+ * drains that ring in **batches** via @ref libe3::py::DAppSession::poll_events "poll_events", so one GIL acquire and
18
18
  * one Python↔C++ boundary crossing are amortised across many messages. The
19
19
  * SWIG wrapper releases the GIL around the blocking calls (see swig/libe3.i,
20
20
  * `%module(threads="1")`), so libe3's C++ threads never stall on Python.
@@ -24,10 +24,10 @@
24
24
  * the OAI split where libe3 owns E3AP and the SM owns encode/decode.
25
25
  *
26
26
  * @section lifecycle Lifecycle
27
- * ctor (registers handlers) → @ref start → @ref wait_for_setup →
28
- * (read setup via @ref dapp_id / setup accessors) → @ref subscribe →
29
- * loop: @ref poll_events + @ref send_control / @ref send_report →
30
- * @ref release → @ref stop.
27
+ * ctor (registers handlers) → @ref libe3::py::DAppSession::start "start" → @ref libe3::py::DAppSession::wait_for_setup "wait_for_setup" →
28
+ * (read setup via @ref libe3::py::DAppSession::dapp_id "dapp_id" / setup accessors) → @ref libe3::py::DAppSession::subscribe "subscribe" →
29
+ * loop: @ref libe3::py::DAppSession::poll_events "poll_events" + @ref libe3::py::DAppSession::send_control "send_control" / @ref libe3::py::DAppSession::send_report "send_report" →
30
+ * @ref libe3::py::DAppSession::release "release" → @ref libe3::py::DAppSession::stop "stop".
31
31
  *
32
32
  * @section rejected Rejected alternatives (auditable)
33
33
  * - SWIG directors: run the Python callback on libe3's inbound thread under the
@@ -54,7 +54,7 @@ namespace libe3 {
54
54
  namespace py {
55
55
 
56
56
  /**
57
- * @brief Discriminator for @ref E3Event.
57
+ * @brief Discriminator for @ref libe3::py::E3Event.
58
58
  */
59
59
  enum E3EventKind {
60
60
  E3_EVENT_NONE = 0, ///< placeholder (never enqueued)
@@ -155,8 +155,13 @@ public:
155
155
 
156
156
  /**
157
157
  * @brief Subscribe to a RAN function (after a positive setup).
158
+ * @param ran_function_id RAN function to subscribe to
159
+ * @param telemetry_ids telemetry identifiers requested
160
+ * @param control_ids control identifiers requested
158
161
  * @param sub_time_ms subscription time, or -1 for unset.
159
- * @param periodicity delivery periodicity (µs), or -1 for unset.
162
+ * @param periodicity microseconds between indications, 0 = every event, or -1 for
163
+ * unset. Over ASN.1 the range is 0 to 60000000. An OCUDU RAN reads the
164
+ * same number as milliseconds.
160
165
  * @return the assigned request id (positive, 1..4294967295) on success, so
161
166
  * the caller can correlate the SubscriptionResponse by its
162
167
  * request_id; a negative ErrorCode on failure.
@@ -171,6 +176,9 @@ public:
171
176
 
172
177
  /**
173
178
  * @brief Send a dApp control action to the RAN.
179
+ * @param ran_function_id RAN function the control is for
180
+ * @param control_id control identifier granted by the RAN
181
+ * @param action_data opaque E3SM control payload
174
182
  * @param sequence_id correlation id of the xApp procedure this control
175
183
  * re-issues; 0 when the dApp decided on its own.
176
184
  * @return the assigned message id (positive, 1..4294967295) on success, so
@@ -184,6 +192,8 @@ public:
184
192
  uint32_t sequence_id = 0);
185
193
  /**
186
194
  * @brief Send a dApp report to the RAN.
195
+ * @param ran_function_id RAN function the report is for
196
+ * @param report_data opaque E3SM report payload
187
197
  * @param sequence_id correlation id this dApp assigns to the detection;
188
198
  * mandatory on the wire, 1..4294967295 (0 is refused with
189
199
  * INVALID_PARAM).
@@ -193,7 +203,7 @@ public:
193
203
  */
194
204
  int64_t send_report(uint32_t ran_function_id, std::vector<uint8_t> report_data,
195
205
  uint32_t sequence_id);
196
- /** @brief Acknowledge a request. @param response_code 0=positive,1=negative. @return ErrorCode as int. */
206
+ /** @brief Acknowledge a request. @param request_id request being acknowledged. @param response_code 0=positive,1=negative. @return ErrorCode as int. */
197
207
  int send_message_ack(uint32_t request_id, int response_code);
198
208
 
199
209
  /**
libe3py-0.2.7/VERSION DELETED
@@ -1 +0,0 @@
1
- 0.2.7
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes