diff --git a/v1.0.0/.documenter-siteinfo.json b/v1.0.0/.documenter-siteinfo.json index d2276b5..8a332a9 100644 --- a/v1.0.0/.documenter-siteinfo.json +++ b/v1.0.0/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-07-22T20:36:17","documenter_version":"1.5.0"}} \ No newline at end of file +{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-07-22T20:38:10","documenter_version":"1.5.0"}} \ No newline at end of file diff --git a/v1.0.0/api/index.html b/v1.0.0/api/index.html index 4dcdca0..64040db 100644 --- a/v1.0.0/api/index.html +++ b/v1.0.0/api/index.html @@ -1,2 +1,2 @@ -API Reference · FXP
GitHub

API Reference

FXP

FXP.has_service_provider — Function
has_service_provider(client::Jedis.Client, service_name::String)

Checks if there is a provider for a given service

source
FXP.json_pop — Function
json_pop(client::Jedis.Client, session_id::String, service_name::String, whoami::Symbol; timeout::Float64, error_on_timeout::Bool=true)

Pops and deserializes JSON data from a Redis list, using a key derived from sessionid, servicename, and whoami

source
FXP.json_push — Function
json_push(client::Jedis.Client, session_id::String, service_name::String, whoami::Symbol; data...)

Pushes serialized JSON data into a Redis list, using a key derived from sessionid, servicename, and whoami

source
FXP.negotiate_service — Function
negotiate_service(client::Jedis.Client, session_id::String, service_name::String)

Initializes service negotiation by cleaning up previous keys and publishing a request on a Redis channel

source
FXP.new_client_copy — Function
new_client_copy(client_in::Jedis.Client)

Creates a copy of a Jedis client with the same connection parameters.

source
FXP.raw_pop — Function
raw_pop(client::Jedis.Client, session_id::String, service_name::String, whoami::Symbol; timeout::Float64, error_on_timeout::Bool=true)

Pops raw data from a Redis list, key determined by sessionid, servicename, and whoami

source
FXP.raw_push — Function
raw_push(client::Jedis.Client, session_id::String, service_name::String, whoami::Symbol, raw_data::Any)

Pushes raw data into a Redis list, key determined by sessionid, servicename, and whoami

source
FXP.register_service — Function
register_service(client::Jedis.Client, service_name::String, service_function::Function; timeout::Float64=10.0)

Registers a service by subscribing to a Redis channel and invoking the service_function when a message is received

The service_function must have the following call signature:

service_function(client::Jedis.Client, session_id::String, service_name::String; timeout::Float64)
source
+API Reference · FXP
GitHub

API Reference

FXP

FXP.has_service_provider — Function
has_service_provider(client::Jedis.Client, service_name::String)

Checks if there is a provider for a given service

source
FXP.json_pop — Function
json_pop(client::Jedis.Client, session_id::String, service_name::String, whoami::Symbol; timeout::Float64, error_on_timeout::Bool=true)

Pops and deserializes JSON data from a Redis list, using a key derived from sessionid, servicename, and whoami

source
FXP.json_push — Function
json_push(client::Jedis.Client, session_id::String, service_name::String, whoami::Symbol; data...)

Pushes serialized JSON data into a Redis list, using a key derived from sessionid, servicename, and whoami

source
FXP.negotiate_service — Function
negotiate_service(client::Jedis.Client, session_id::String, service_name::String)

Initializes service negotiation by cleaning up previous keys and publishing a request on a Redis channel

source
FXP.new_client_copy — Function
new_client_copy(client_in::Jedis.Client)

Creates a copy of a Jedis client with the same connection parameters.

source
FXP.raw_pop — Function
raw_pop(client::Jedis.Client, session_id::String, service_name::String, whoami::Symbol; timeout::Float64, error_on_timeout::Bool=true)

Pops raw data from a Redis list, key determined by sessionid, servicename, and whoami

source
FXP.raw_push — Function
raw_push(client::Jedis.Client, session_id::String, service_name::String, whoami::Symbol, raw_data::Any)

Pushes raw data into a Redis list, key determined by sessionid, servicename, and whoami

source
FXP.register_service — Function
register_service(client::Jedis.Client, service_name::String, service_function::Function; timeout::Float64=10.0)

Registers a service by subscribing to a Redis channel and invoking the service_function when a message is received

The service_function must have the following call signature:

service_function(client::Jedis.Client, session_id::String, service_name::String; timeout::Float64)
source
diff --git a/v1.0.0/index.html b/v1.0.0/index.html index 2b4e69c..6d314d8 100644 --- a/v1.0.0/index.html +++ b/v1.0.0/index.html @@ -30,4 +30,4 @@ note over REDIS: ID__X__pro2req REDIS->>-FUSE: brpop service outputs end - end

FXP builds on top of REDIS

Online documentation

For more details, see the online documentation.

Docs

+ end

FXP builds on top of REDIS

Online documentation

For more details, see the online documentation.

Docs

diff --git a/v1.0.0/license/index.html b/v1.0.0/license/index.html index c1730b7..fa3a780 100644 --- a/v1.0.0/license/index.html +++ b/v1.0.0/license/index.html @@ -8,4 +8,4 @@ comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier - identification within third-party archives.

Copyright 2024 General Atomics

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.

+ identification within third-party archives.

Copyright 2024 General Atomics

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.

diff --git a/v1.0.0/notice/index.html b/v1.0.0/notice/index.html index 6131603..bf25b5a 100644 --- a/v1.0.0/notice/index.html +++ b/v1.0.0/notice/index.html @@ -1,2 +1,2 @@ -Notice · FXP
GitHub

FXP.jl Notice

The purpose of this NOTICE file is to provide legal notices and acknowledgments that must be displayed to users in any derivative works or distributions. This file does not alter the terms of the Apache 2.0 license that governs the use and distribution of the FXP.jl package.

Development Attribution

FXP.jl was originally developed under the FUSE project by the Magnetic Fusion Energy group at General Atomics.

Citation

If this software contributes to an academic publication, please cite it as follows:

O. Meneghini, T. Slendebroek, B.C. Lyons, K. McLaughlin, J. McClenaghan, L. Stagner, J. Harvey, T.F. Neiser, A. Ghiozzi, G. Dose, J. Guterl, A. Zalzali, T. Cote, N. Shi, D. Weisberg, S.P. Smith, B.A. Grierson, FUSE: A next generation framework for integrated design of fusion pilot plants, Proceedings of the IAEA FEC 2023 Conference, (2023)

Trademark Notice

The names "General Atomics", and any associated logos or images, are trademarks of General Atomics. Use of these trademarks without prior written consent from General Atomics is strictly prohibited. Users cannot imply endorsement by General Atomics or contributors to the project simply because the project is part of their work.

Copyright (c) 2024 General Atomics

Version

Version: v1.0

+Notice · FXP
GitHub

FXP.jl Notice

The purpose of this NOTICE file is to provide legal notices and acknowledgments that must be displayed to users in any derivative works or distributions. This file does not alter the terms of the Apache 2.0 license that governs the use and distribution of the FXP.jl package.

Development Attribution

FXP.jl was originally developed under the FUSE project by the Magnetic Fusion Energy group at General Atomics.

Citation

If this software contributes to an academic publication, please cite it as follows:

O. Meneghini, T. Slendebroek, B.C. Lyons, K. McLaughlin, J. McClenaghan, L. Stagner, J. Harvey, T.F. Neiser, A. Ghiozzi, G. Dose, J. Guterl, A. Zalzali, T. Cote, N. Shi, D. Weisberg, S.P. Smith, B.A. Grierson, FUSE: A next generation framework for integrated design of fusion pilot plants, Proceedings of the IAEA FEC 2023 Conference, (2023)

Trademark Notice

The names "General Atomics", and any associated logos or images, are trademarks of General Atomics. Use of these trademarks without prior written consent from General Atomics is strictly prohibited. Users cannot imply endorsement by General Atomics or contributors to the project simply because the project is part of their work.

Copyright (c) 2024 General Atomics

Version

Version: v1.0