Skip to content

Commit

Permalink
* Added Readme and disclaimer to server example
Browse files Browse the repository at this point in the history
  • Loading branch information
mkvanhooft committed Jan 22, 2024
1 parent 2cf1b67 commit f115af5
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
12 changes: 12 additions & 0 deletions examples/advanced/server/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Server example
++++++++++++++
This example shows how to create a server that can process incoming requests from multiple clients,
puts these requests on a queue and will execute these requests one by one.

DISCLAIMER
============
This example uses Netsquid Protocols in order to create listeners for each classical socket and other functionalities.
In a setting where one runs an application on hardware, one would, for example, start and use a thread for each listener.
But in SquidASM one can not create a functional application in the same fashion due the underlying discrete event simulator, Netsquid.
In this example, the appropriate Netsquid Protocols have been created to achieve the desired functionality,
but as these do not translate to hardware, any application written using them will require a larger translation to be compatible with hardware.
14 changes: 14 additions & 0 deletions examples/advanced/server/netsquid_protocols.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
"""
DISCLAIMER
============
This file creates various Netsquid Protocols in order to create listeners for each classical socket
and other functionalities.
In a setting where one runs an application on hardware, one would, for example,
start and use a thread for each listener.
But in SquidASM one can not create a functional application in the same fashion
due the underlying discrete event simulator, Netsquid.
In this file, Netsquid Protocols have been created, but as these do not translate to hardware,
any application written using them will require a larger translation to be compatible with hardware.
"""

from logging import Logger
from typing import Generator, Tuple

Expand Down

0 comments on commit f115af5

Please sign in to comment.