Expose write events to .NET API consumer #153
Merged
Conversation
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
The access level of the 'Writer' property in the Proxy.cs file has been changed from internal to public. This change also includes the addition of a brief summary for the property, which will be visible in intellisense and documentation.
In the RealtimeArchiveWriter class, comments detailing what each method does were added. Each summary includes a concise explanation of the method purpose, the expected parameters, and potential return values where applicable. Included descriptions for the class itself and the ArchiveUpdateType enum as well.
The Short timeout constant has been added to the TimeoutConstants class. This new constant will return 15 if the current platform is OSX, and 10 otherwise. This will help the test cases to run with appropriate timeouts based on the OS platform.
A new file named EventWriterTests.cs was added in the UnitTests directory. This file contains tests for the EventWriter class of the Fluxzy library. In particular, it provides a test for checking the completion of an exchange update through a proxy.
haga-rak
added a commit
that referenced
this pull request
Feb 12, 2024
* Increase access level of property in Proxy.cs The access level of the 'Writer' property in the Proxy.cs file has been changed from internal to public. This change also includes the addition of a brief summary for the property, which will be visible in intellisense and documentation. * Add method documentation to RealtimeArchiveWriter In the RealtimeArchiveWriter class, comments detailing what each method does were added. Each summary includes a concise explanation of the method purpose, the expected parameters, and potential return values where applicable. Included descriptions for the class itself and the ArchiveUpdateType enum as well. * Add Short timeout constant to TimeoutConstants The Short timeout constant has been added to the TimeoutConstants class. This new constant will return 15 if the current platform is OSX, and 10 otherwise. This will help the test cases to run with appropriate timeouts based on the OS platform. * Add EventWriterTests for Fluxzy A new file named EventWriterTests.cs was added in the UnitTests directory. This file contains tests for the EventWriter class of the Fluxzy library. In particular, it provides a test for checking the completion of an exchange update through a proxy. --------- Co-authored-by: fluxzy-ci <admin@fluxzy.io>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This update allows a .NET consumer to access read-only writer events throught
Proxy.Writerproperty.The main events accessibles are:
proxy.Writer.ExchangeUpdatedwhich is triggered when on of the events inArchiveUpdateTypeoccured.proxy.Writer.ConnectionUpdatedwhich is triggered when a new connection is added or updated.These events provide only access code for read-only hook. For hooks that alter the exchange or the connection, consider using straightforward implementation of
FilterandAction