Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
client
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Deploy
Releases
Package registry
Container Registry
Model registry
Operate
Terraform modules
Analyze
Contributor analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
elixxir
client
Commits
b5597c01
Commit
b5597c01
authored
2 years ago
by
Josh Brooks
Browse files
Options
Downloads
Patches
Plain Diff
Update bindings documentation
parent
70852e00
No related branches found
No related tags found
2 merge requests
!510
Release
,
!331
Hotfix/dummy message clean up
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
bindings/dummy.go
+8
-7
8 additions, 7 deletions
bindings/dummy.go
with
8 additions
and
7 deletions
bindings/dummy.go
+
8
−
7
View file @
b5597c01
...
...
@@ -53,7 +53,7 @@ func NewDummyTrafficManager(cmixId, maxNumMessages, avgSendDeltaMS,
return
&
DummyTraffic
{
m
},
net
.
api
.
AddService
(
m
.
StartDummyTraffic
)
}
// SetStatus sets the state of the
d
ummy
t
raffic send thread by passing in
// SetStatus sets the state of the
D
ummy
T
raffic
manager's
send thread by passing in
// a boolean parameter. There may be a small delay in between this call
// and the status of the sending thread to change accordingly. For example,
// passing False into this call while the sending thread is currently sending messages
...
...
@@ -61,8 +61,8 @@ func NewDummyTrafficManager(cmixId, maxNumMessages, avgSendDeltaMS,
// operation has completed.
//
// Params:
// - boolean -
True: Sending thread is
send
ing
dummy messages.
//
False: Sending thread is paused/stopped and is not sending
dummy messages.
// - boolean -
Input should be true if you want to
send dummy messages.
//
Input should be false if you want to pause
dummy messages.
// Returns:
// - error - if the DummyTraffic.SetStatus is called too frequently, causing the
// internal status channel to fill.
...
...
@@ -70,15 +70,16 @@ func (dt *DummyTraffic) SetStatus(status bool) error {
return
dt
.
m
.
SetStatus
(
status
)
}
// GetStatus returns the current state of the
d
ummy
t
raffic sending thread.
// GetStatus returns the current state of the
D
ummy
T
raffic
manager's
sending thread.
// Note that this function does not return the status set by the most recent call to
// SetStatus
directly
. Instead, this call returns the current status of the sending thread.
// SetStatus. Instead, this call returns the current status of the sending thread.
// This is due to the small delay that may occur between calling SetStatus and the
// sending thread taking into effect that status change.
//
// Returns:
// - boolean - True: Sending thread is sending dummy messages.
// - False: Sending thread is paused/stopped and is not sending dummy messages.
// - boolean - Returns true if sending thread is sending dummy messages.
// Returns false if sending thread is paused/stopped and is
// not sending dummy messages.
func
(
dt
*
DummyTraffic
)
GetStatus
()
bool
{
return
dt
.
m
.
GetStatus
()
}
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment