[#284] link events and pre events, improve README #285
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
elbrujohalcon
requested changes
Oct 13, 2016
| @@ -75,6 +75,48 @@ These three concepts have a specific meaning in the context of sumo_db. | |||
| TO implement an adapter, you must implement two behaviors: `sumo_backend` and | |||
| `sumo_store`. | |||
|
|
|||
| ## Events | |||
|
|
|||
| Sumo throws events when things happen. An Event has this structure: | |||
| - `Event` is the type of the event. | ||
| - `Args` extra data sent. | ||
|
|
||
| Those are the current supported events: |
There was a problem hiding this comment.
supported types of events
(to match the paragraph above)
|
|
||
| Those are the current supported events: | ||
|
|
||
| - `pre_persisted` just before persisting some entity. This event has the entity we want to persist as an `Args`. It is throw on this function: |
|
|
||
| - `pre_persisted` just before persisting some entity. This event has the entity we want to persist as an `Args`. It is throw on this function: | ||
| - `sumo:persist/2` | ||
| - `persisted` just after persisting some entity. This event hast the persisted entity as an `Args` It is throw on this function: |
There was a problem hiding this comment.
Add a note stating that it keeps the same EventId as the corresponding pre_persisted
| - `sumo:persist/2` | ||
| - `persisted` just after persisting some entity. This event hast the persisted entity as an `Args` It is throw on this function: | ||
| - `sumo:persist/2` | ||
| - `pre_delete_all` just before deleting all entities for one model. This event has no `Args`. It is throw on this function: |
| - `schema_created` just after creating a sumo schema. This event has no `Args`. It is throw on this function: | ||
| - `sumo:create_schema/2` | ||
|
|
||
| Sumo allows users to add their own `gen_event`'s in order to handle those events. In order to add them Users have to configure sumo properly. In the `config` file we can add them like this under `sumo_db` configuration: |
| @@ -41,6 +46,7 @@ dispatch(DocName, Event, Args) -> | |||
| ok; | |||
| EventManagers -> | |||
| lists:foreach(fun(EventManager) -> | |||
| gen_event:notify(EventManager, {DocName, Event, Args}) | |||
| EventId = make_ref(), | |||
There was a problem hiding this comment.
This will not work… EventId must be preserved between linked instances of pre_ and regular events
elbrujohalcon
approved these changes
Oct 13, 2016
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.
[close #284]