diff options
| author | Neels Janosch Hofmeyr <nhofmeyr@sysmocom.de> | 2022-11-06 22:21:39 +0100 |
|---|---|---|
| committer | neels <nhofmeyr@sysmocom.de> | 2022-11-11 18:59:06 +0000 |
| commit | 3a86c92dce58737ba9fc137894b5f21986f58ca5 (patch) | |
| tree | 35f01ae42c52715ff1da2732cee44d5d9e75c494 | |
| parent | 24b06cd451cd52395723253afb8199e95caf6e87 (diff) | |
api doc: explain heartbeat handling in rx_msg_cb
Related: SYS#5599
Change-Id: I3849060d703494ea43773c0208203f1fc206067f
| -rw-r--r-- | include/osmocom/pfcp/pfcp_endpoint.h | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/include/osmocom/pfcp/pfcp_endpoint.h b/include/osmocom/pfcp/pfcp_endpoint.h index d0ed113..7158582 100644 --- a/include/osmocom/pfcp/pfcp_endpoint.h +++ b/include/osmocom/pfcp/pfcp_endpoint.h @@ -69,7 +69,10 @@ struct osmo_pfcp_endpoint_cfg { osmo_pfcp_endpoint_cb set_msg_ctx_cb; /* Callback to receive a single incoming PFCP message from a remote peer, already decoded. See also the doc for - * osmo_pfcp_endpoint_cb. */ + * osmo_pfcp_endpoint_cb. + * All incoming messages are passed to this callback, including Heartbeat Request and Heartbeat Response + * messages. However, responding to heartbeat is already done in osmo_pfcp_endpoint_handle_rx() before + * rx_msg_cb() is invoked: a callback implementation can safely ignore Heartbeat Request messages. */ osmo_pfcp_endpoint_cb rx_msg_cb; /* Custom timer definitions to use, if any. Relevant timers are: OSMO_PFCP_TIMER_N1, OSMO_PFCP_TIMER_T1, |