coordinator.server_state.ServerState Class Reference

Public Member Functions
def	__init__ (self, int next_contributor_index, int num_contributors, float next_contributor_deadline)
str	to_json (self)
bool	have_all_contributions (self)
None	received_contribution (self, float next_deadline)
bool	update (self, float now, float interval)

Static Public Member Functions
ServerState	from_json (str state_json)

Public Attributes
	next_contributor_index
	next_contributor_deadline

Detailed Description

Current state of the server

Definition at line 14 of file server_state.py.

Constructor & Destructor Documentation

__init__()

def coordinator.server_state.ServerState.__init__	(		self,
		int	next_contributor_index,
		int	num_contributors,
		float	next_contributor_deadline
	)

Definition at line 18 of file server_state.py.

    def __init__(
            self,
            next_contributor_index: int,
            num_contributors: int,
            next_contributor_deadline: float):
        self.next_contributor_index: int = next_contributor_index
        self.num_contributors: int = num_contributors
        self.next_contributor_deadline: float = next_contributor_deadline
        assert self.num_contributors != 0
 

Member Function Documentation

from_json()

ServerState coordinator.server_state.ServerState.from_json ( str  state_json )

static

Definition at line 32 of file server_state.py.

    def from_json(state_json: str) -> ServerState:
        return ServerState._from_json_dict(
            json.loads(state_json))
 

have_all_contributions()

bool coordinator.server_state.ServerState.have_all_contributions

(

self

)

returns True if all contributions have been received

Definition at line 36 of file server_state.py.

    def have_all_contributions(self) -> bool:
        """
        returns True if all contributions have been received
        """
        return self.num_contributors <= self.next_contributor_index
 

Here is the caller graph for this function:

received_contribution()

None coordinator.server_state.ServerState.received_contribution	(		self,
		float	next_deadline
	)

Update the state after new contribution has been successfully received.

Definition at line 42 of file server_state.py.

    def received_contribution(self, next_deadline: float) -> None:
        """
        Update the state after new contribution has been successfully received.
        """
        assert not self.have_all_contributions()
        self._next_contributor(next_deadline)
 

Here is the call graph for this function:

to_json()

str coordinator.server_state.ServerState.to_json

(

self

)

Definition at line 28 of file server_state.py.

    def to_json(self) -> str:
        return json.dumps(self._to_json_dict())
 

Here is the call graph for this function:

update()

bool coordinator.server_state.ServerState.update	(		self,
		float	now,
		float	interval
	)

Check whether a contributor has missed his chance and update internal
state accordingly. If the deadline has passed, return True. Otherwise
return False.

Definition at line 49 of file server_state.py.

    def update(self, now: float, interval: float) -> bool:
        """
        Check whether a contributor has missed his chance and update internal
        state accordingly. If the deadline has passed, return True. Otherwise
        return False.
        """
        # If the next contributor deadline has passed, update
        if self.next_contributor_deadline <= 0.0 or \
           now < self.next_contributor_deadline:
            return False
 
        self._next_contributor(now + interval)
        return True
 

Here is the call graph for this function:

Member Data Documentation

next_contributor_deadline

coordinator.server_state.ServerState.next_contributor_deadline

Definition at line 66 of file server_state.py.

next_contributor_index

coordinator.server_state.ServerState.next_contributor_index

Definition at line 64 of file server_state.py.

---

The documentation for this class was generated from the following file:

• /home/runner/work/zeth/zeth/mpc/coordinator/server_state.py