ae8f6044ae113bc384afef1c4c6fb387454080a6
[ldk-java] / src / main / java / org / ldk / structs / CustomOnionMessageHandler.java
1 package org.ldk.structs;
2
3 import org.ldk.impl.bindings;
4 import org.ldk.enums.*;
5 import org.ldk.util.*;
6 import java.util.Arrays;
7 import java.lang.ref.Reference;
8 import javax.annotation.Nullable;
9
10 /**
11  * Handler for custom onion messages. If you are using [`SimpleArcOnionMessenger`],
12  * [`SimpleRefOnionMessenger`], or prefer to ignore inbound custom onion messages,
13  * [`IgnoringMessageHandler`] must be provided to [`OnionMessenger::new`]. Otherwise, a custom
14  * implementation of this trait must be provided, with [`CustomMessage`] specifying the supported
15  * message types.
16  * 
17  * See [`OnionMessenger`] for example usage.
18  * 
19  * [`IgnoringMessageHandler`]: crate::ln::peer_handler::IgnoringMessageHandler
20  * [`CustomMessage`]: Self::CustomMessage
21  */
22 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
23 public class CustomOnionMessageHandler extends CommonBase {
24         final bindings.LDKCustomOnionMessageHandler bindings_instance;
25         CustomOnionMessageHandler(Object _dummy, long ptr) { super(ptr); bindings_instance = null; }
26         private CustomOnionMessageHandler(bindings.LDKCustomOnionMessageHandler arg) {
27                 super(bindings.LDKCustomOnionMessageHandler_new(arg));
28                 this.ptrs_to.add(arg);
29                 this.bindings_instance = arg;
30         }
31         @Override @SuppressWarnings("deprecation")
32         protected void finalize() throws Throwable {
33                 if (ptr != 0) { bindings.CustomOnionMessageHandler_free(ptr); } super.finalize();
34         }
35
36         public static interface CustomOnionMessageHandlerInterface {
37                 /**
38                  * Called with the custom message that was received.
39                  */
40                 void handle_custom_message(CustomOnionMessageContents msg);
41                 /**
42                  * Read a custom message of type `message_type` from `buffer`, returning `Ok(None)` if the
43                  * message type is unknown.
44                  */
45                 Result_COption_CustomOnionMessageContentsZDecodeErrorZ read_custom_message(long message_type, byte[] buffer);
46         }
47         private static class LDKCustomOnionMessageHandlerHolder { CustomOnionMessageHandler held; }
48         public static CustomOnionMessageHandler new_impl(CustomOnionMessageHandlerInterface arg) {
49                 final LDKCustomOnionMessageHandlerHolder impl_holder = new LDKCustomOnionMessageHandlerHolder();
50                 impl_holder.held = new CustomOnionMessageHandler(new bindings.LDKCustomOnionMessageHandler() {
51                         @Override public void handle_custom_message(long msg) {
52                                 CustomOnionMessageContents ret_hu_conv = new CustomOnionMessageContents(null, msg);
53                                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
54                                 arg.handle_custom_message(ret_hu_conv);
55                                 Reference.reachabilityFence(arg);
56                         }
57                         @Override public long read_custom_message(long message_type, byte[] buffer) {
58                                 Result_COption_CustomOnionMessageContentsZDecodeErrorZ ret = arg.read_custom_message(message_type, buffer);
59                                 Reference.reachabilityFence(arg);
60                                 long result = ret == null ? 0 : ret.clone_ptr();
61                                 return result;
62                         }
63                 });
64                 return impl_holder.held;
65         }
66         /**
67          * Called with the custom message that was received.
68          */
69         public void handle_custom_message(org.ldk.structs.CustomOnionMessageContents msg) {
70                 bindings.CustomOnionMessageHandler_handle_custom_message(this.ptr, msg == null ? 0 : msg.ptr);
71                 Reference.reachabilityFence(this);
72                 Reference.reachabilityFence(msg);
73                 if (this != null) { this.ptrs_to.add(msg); };
74         }
75
76         /**
77          * Read a custom message of type `message_type` from `buffer`, returning `Ok(None)` if the
78          * message type is unknown.
79          */
80         public Result_COption_CustomOnionMessageContentsZDecodeErrorZ read_custom_message(long message_type, byte[] buffer) {
81                 long ret = bindings.CustomOnionMessageHandler_read_custom_message(this.ptr, message_type, buffer);
82                 Reference.reachabilityFence(this);
83                 Reference.reachabilityFence(message_type);
84                 Reference.reachabilityFence(buffer);
85                 if (ret >= 0 && ret <= 4096) { return null; }
86                 Result_COption_CustomOnionMessageContentsZDecodeErrorZ ret_hu_conv = Result_COption_CustomOnionMessageContentsZDecodeErrorZ.constr_from_ptr(ret);
87                 return ret_hu_conv;
88         }
89
90 }