Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
neuecc committed Jan 13, 2022
1 parent a8da0c4 commit 1aefaec
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,10 @@ The before and after of execution can be changed by passing a custom filter. See

If an error occurs, it will be propagated to the caller and subsequent subscribers will be stopped. This behavior can be changed by writing a filter to ignore errors.

ISingleton***, IScoped***
---
I(Async)Publisher(Subscriber)'s lifetime is belonging `MessagePipeOptions.InstanceLifetime`. However if declare with `ISingletonPublisher<TMessage>/ISingletonSubscriber<TKey, TMessage>`, `ISingletonAsyncPublisher<TMessage>/ISingletonAsyncSubscriber<TKey, TMessage>` then used singleton lifetime. Also `IScopedPublisher<TMessage>/IScopedSubscriber<TKey, TMessage>`, `IScopedAsyncPublisher<TMessage>/IScopedAsyncSubscriber<TKey, TMessage>` uses scoped lifetime.

Buffered
---
`IBufferedPublisher<TMessage>/IBufferedSubscriber<TMessage>` pair is similar as `BehaviorSubject` or Reactive Extensions(More equal is RxSwift's `BehaviorRelay`). It returns latest value on `Subscribe`.
Expand Down Expand Up @@ -871,7 +875,7 @@ For the interprocess(NamedPipe/UDP/TCP) Pub/Sub(IPC), you can use `IDistributedP
MessagePipe.Interprocess is also exsits on Unity(except NamedPipe).

use `AddMessagePipeUdpInterprocess`, `AddMessagePipeTcpInterprocess`, `AddMessagePipeNamedPipeInterprocess` to enable interprocess provider.
use `AddMessagePipeUdpInterprocess`, `AddMessagePipeTcpInterprocess`, `AddMessagePipeNamedPipeInterprocess`, `AddMessagePipeUdpInterprocessUds`, `AddMessagePipeTcpInterprocessUds` to enable interprocess provider(Uds is Unix domain socket, most performant option).

```csharp
Host.CreateDefaultBuilder()
Expand All @@ -881,6 +885,8 @@ Host.CreateDefaultBuilder()
services.AddMessagePipeUdpInterprocess("127.0.0.1", 3215, configure); // setup host and port.
// services.AddMessagePipeTcpInterprocess("127.0.0.1", 3215, configure);
// services.AddMessagePipeNamedPipeInterprocess("messagepipe-namedpipe", configure);
// services.AddMessagePipeUdpInterprocessUds("domainSocketPath")
// services.AddMessagePipeTcpInterprocessUds("domainSocketPath")
})
```

Expand Down

0 comments on commit 1aefaec

Please sign in to comment.