neels has uploaded this change for review. ( https://gerrit.osmocom.org/c/libosmo-pfcp/+/30046 )

Change subject: api doc: explain heartbeat handling in rx_msg_cb ......................................................................

api doc: explain heartbeat handling in rx_msg_cb

Related: SYS#5599 Change-Id: I3849060d703494ea43773c0208203f1fc206067f --- M include/osmocom/pfcp/pfcp_endpoint.h 1 file changed, 4 insertions(+), 1 deletion(-)

git pull ssh://gerrit.osmocom.org:29418/libosmo-pfcp refs/changes/46/30046/1

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 @@ 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,