Create 2023-11-28-server-recon-explained.md #145
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
draft 1 of server.recon explainer
SirCipher
requested changes
Dec 8, 2023
|
|
||
| Here, `id` is a route variable used to uniquely identify a given `CityAgent`. | ||
|
|
||
| The second approach consists of specify the underlying web address for a specific agent. When using this, it is customary to specify a `seed` field for the corresponding `@agent` attribute that populates a `seed` field with configuration info, such as the name of a file. `swim.api.agent.AbstractAgent.getProp("seed")` can then be invoked on the Web Agent to retrieve the configuration information. |
There was a problem hiding this comment.
@SirCipher fixed: 3c803c7
| In same cases, it may be desirable to specify multiple `@agent` attributes for the same configuration. This allows a component approach that separates concerns, such as having both a core agent and a logging agent. What happens is that each Web Agent implementation is matched against `@SwimLane` defined on each Web Agent, and each corresponding lane match is invoked. As a result, multiple Web Agents may run concurrently as a single Web Agent entity. | ||
|
|
||
| ## Kernel Directives | ||
|
|
There was a problem hiding this comment.
I'd detail what a kernel is here
There was a problem hiding this comment.
@SirCipher fixed: 3c803c7
apply suggested edit about recon Co-authored-by: Thomas Klapwijk <[email protected]>
apply change to uppercase bullet items Co-authored-by: Thomas Klapwijk <[email protected]>
accdept edit for bundled UIs Co-authored-by: Thomas Klapwijk <[email protected]>
accept suggested edits for describing websocket attribute Co-authored-by: Thomas Klapwijk <[email protected]>
remove text as suggested regarding server compression Co-authored-by: Thomas Klapwijk <[email protected]>
correct mispelling of example Co-authored-by: Thomas Klapwijk <[email protected]>
accept added text detailing resources directory Co-authored-by: Thomas Klapwijk <[email protected]>
I have relocated recon server configuration to the recon related reference page. #130
Give an example of specify a seed for an agent and explain what a kernel is.
ajay-gov
requested changes
Feb 28, 2024
There was a problem hiding this comment.
@StreamingDataApps the structure of the site here is quite different from the live site. Seems like you are using an older version. Can you merge main into your branch and then make the changes in the right place. That way it will be easier to review. Thanks
ajay-gov
requested changes
Feb 29, 2024
There was a problem hiding this comment.
- We need a separate section for this called "Server Configuration". It doesn't fit into the
Reconsection since that section describes theRecongrammar and syntax. The server configuration just happens to be in recon format - Will be good to mention that the Swim Server looks for the server.recon in the classpath (not just src/main/resources). Also we should describe how the config file can be loaded using the `swim.config`` system property
- DocumentRoot is superseded by the
UIRouter, let's remove references to it - "The value of this field will be the same name used when defining the fabric attribute"- this is super important and should be highlighted or emphasized. Might be good to mention this again in the
@fabricsection. Have wasted a lot of time debugging only because these two didn't match - "When the server is run, the plane’s main() method will be invoked to instantiate the server application"- this isn't true. The main method can be defined in any class. It will be good to menti that typically we add the main method to the Plane class where we load the kernel using ServerLoader (maybe a reference to the right section about this as well?)
- In the
@nodesection, we should also mention node uri patterns dynamic agent instantiaton, node uris for automatic agent instatntiation with that uri and traits where there are multiple class definition for a single node uri (dynamic polymorphism). It can be brief and we should link to the relevant section on these items
Most of the requested fixes: - Will be good to mention that the Swim Server looks for the server.recon in the classpath (not just src/main/resources). Also we should describe how the config file can be loaded using the `swim.config`` system property - DocumentRoot is superseded by the UIRouter, let's remove references to it - "The value of this field will be the same name used when defining the fabric attribute"- this is super important and should be highlighted or emphasized. Might be good to mention this again in the @fabric section. Have wasted a lot of time debugging only because these two didn't match - "When the server is run, the plane’s main() method will be invoked to instantiate the server application"- this isn't true. The main method can be defined in any class. It will be good to menti that typically we add the main method to the Plane class where we load the kernel using ServerLoader (maybe a reference to the right section about this as well?)
✅ Deploy Preview for scintillating-strudel-60ff56 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
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.
draft 1 of server.recon explainer