-
Notifications
You must be signed in to change notification settings - Fork 18
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Implement local watcher #182
Closed
manoranjith
wants to merge
10
commits into
hyperledger-labs:dev
from
boschresearch:174-implement-local-watcher
Closed
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
0ab1a9a
:sparkles: [channel] Define smaller interfaces for methods in adjudic…
1733588
:sparkles: [channel/adjudicator,watcher] Add interface defs for watcher
cab8bfa
:sparkles: [watcher/local] Implement local states pub-sub
e68a7fc
:sparkles: [watcher/local] Implement local adjudicator pub-sub
2fcc5e3
:sparkles: [watcher/local] Implement a channel registry
554b84a
:sparkles: [watcher/local] Implement start watching functionality
3e5b474
:sparkles: [watcher/local] Handle adj events without dispute
6373839
:sparkles: [watcher/local] Handle adj events with dispute
4544b58
:sparkles: [watcher/local] Relay progressed events to client
ba8bbb9
:sparkles: [watcher/local] Implement stop watching API
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
// Copyright 2021 - See NOTICE file for copyright holders. | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
package local | ||
|
||
import ( | ||
"github.com/pkg/errors" | ||
|
||
"perun.network/go-perun/channel" | ||
"perun.network/go-perun/pkg/sync/atomic" | ||
"perun.network/go-perun/watcher" | ||
) | ||
|
||
var _ watcher.AdjudicatorSub = &adjudicatorPubSub{} | ||
|
||
type ( | ||
adjudicatorPubSub struct { | ||
closed atomic.Bool | ||
err error | ||
pipe chan channel.AdjudicatorEvent | ||
} | ||
|
||
adjudicatorPub interface { | ||
publish(channel.AdjudicatorEvent) | ||
close() error | ||
} | ||
) | ||
|
||
func newAdjudicatorEventsPubSub() *adjudicatorPubSub { | ||
return &adjudicatorPubSub{ | ||
pipe: make(chan channel.AdjudicatorEvent, 10), | ||
} | ||
} | ||
|
||
func (a *adjudicatorPubSub) publish(e channel.AdjudicatorEvent) { | ||
a.pipe <- e | ||
} | ||
|
||
// Close closes the publisher instance and all the subscriptions associated | ||
// with it. Any further call to Publish should immediately return error. | ||
func (a *adjudicatorPubSub) close() error { | ||
if a.closed.IsSet() { | ||
return errors.New("publisher is closed") | ||
} | ||
a.err = errors.WithStack(ErrAlreadyClosed) | ||
close(a.pipe) | ||
a.closed.Set() | ||
return nil | ||
} | ||
|
||
func (a *adjudicatorPubSub) EventStream() <-chan channel.AdjudicatorEvent { | ||
return a.pipe | ||
} | ||
|
||
// Err returns the error after the the subscription is closed. | ||
func (a *adjudicatorPubSub) Err() error { | ||
return a.err | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wha happens if
EventStream()
is called twice? Should the implementation support multiplexing?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated documentation that
Repeated calls to the EventStream method returns the same channel instance.
in PR #212.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think multiplexing is not necessary in our use case, because the only consumer of the events is the watch function.
If at a later point in time, we have the need for consuming the events in multiple places, then we could implement multiplexing.