ClnClient (DotNetLightning)

ClnClient Type

Namespace: DotNetLightning.ClnRpc
Assembly: DotNetLightning.ClnRpc.dll
Base Type: obj

c-lightning rpc client.

Constructors

Constructor Description

Constructor	Description
`ClnClient(network, ?address, ?jsonLibrary, ?getTransport)` Full Usage: `ClnClient(network, ?address, ?jsonLibrary, ?getTransport)` Parameters: network : `Network` - bitcoin network name ?address : `Uri` - Uri to connect for RPC call. it can be either tcp or unix socket. ?jsonLibrary : `JsonLibraryType` - Which json serializer you want to use. ?getTransport : `Func<CancellationToken, Task<Stream>>` - Stream getter. If you specify `address`, than it will automatically use NetworkStream. Otherwise, you can set other stream. This is useful for testing or STDIN/STDOUT for plugin. Returns: `ClnClient`	network : `Network` bitcoin network name ?address : `Uri` Uri to connect for RPC call. it can be either tcp or unix socket. ?jsonLibrary : `JsonLibraryType` Which json serializer you want to use. ?getTransport : `Func<CancellationToken, Task<Stream>>` Stream getter. If you specify `address`, than it will automatically use NetworkStream. Otherwise, you can set other stream. This is useful for testing or STDIN/STDOUT for plugin. Returns: `ClnClient`


                
                  
                    
                      ClnClient(network, ?address, ?jsonLibrary, ?getTransport)

Full Usage: ClnClient(network, ?address, ?jsonLibrary, ?getTransport)

Parameters:

network : Network - bitcoin network name

?address : Uri - Uri to connect for RPC call. it can be either tcp or unix socket.

?jsonLibrary : JsonLibraryType - Which json serializer you want to use.

?getTransport : Func<CancellationToken, Task<Stream>> - Stream getter. If you specify address, than it will automatically use NetworkStream. Otherwise, you can set other stream. This is useful for testing or STDIN/STDOUT for plugin.

Returns: ClnClient

network : Network: bitcoin network name
?address : Uri: Uri to connect for RPC call. it can be either tcp or unix socket.
?jsonLibrary : JsonLibraryType: Which json serializer you want to use.
?getTransport : Func<CancellationToken, Task<Stream>>: Stream getter. If you specify address, than it will automatically use NetworkStream. Otherwise, you can set other stream. This is useful for testing or STDIN/STDOUT for plugin.

Returns: ClnClient

Instance members

Instance member	Description
`this.NewtonSoftJsonConverters` Full Usage: `this.NewtonSoftJsonConverters` Returns: `ResizeArray<JsonConverter>`	Returns: `ResizeArray<JsonConverter>`
`this.STJConverters` Full Usage: `this.STJConverters` Returns: `ResizeArray<JsonConverter>`	Returns: `ResizeArray<JsonConverter>`
`this.SendCommandAsync` Full Usage: `this.SendCommandAsync` Parameters: methodName : `string` req : `obj` ?noReturn : `bool` ?ct : `CancellationToken` Returns: `Task<'T>`	methodName : `string` req : `obj` ?noReturn : `bool` ?ct : `CancellationToken` Returns: `Task<'T>`
`this.SendNotification` Full Usage: `this.SendNotification` Parameters: methodName : `string` req : `obj` ?ct : `CancellationToken` Returns: `Task`	methodName : `string` req : `obj` ?ct : `CancellationToken` Returns: `Task`