Skip to content

Commit ad9847c

Browse files
committed
Document how message is de/serialized
1 parent 09cf391 commit ad9847c

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

libpkl/src/main/c/pkl.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ typedef struct PKL_EXEC_T {
3434
/**
3535
* The callback that gets called when a message is received from Pkl.
3636
*
37+
* Messages must be deserialized to Pkl's Message Passing API: https://pkl-lang.org/main/current/bindings-specification/message-passing-api.html
38+
*
3739
* @param length The length the message bytes
3840
* @param message The message itself
3941
* @param userData User-defined data passed in from pkl_init.
@@ -53,6 +55,8 @@ pkl_exec_t *pkl_init(PklMessageResponseHandler handler, void *userData);
5355
/**
5456
* Send a message to Pkl, providing the length and a pointer to the first byte.
5557
*
58+
* Messages must be serialized to Pkl's Message Passing API: https://pkl-lang.org/main/current/bindings-specification/message-passing-api.html
59+
*
5660
* @param pexec The Pkl executor instance.
5761
* @param length The length of the message, in bytes.
5862
* @param message The message to send to Pkl.

0 commit comments

Comments
 (0)