introduce lock, unlock, islocked, isready, get! and deprecate get, request, release

[Krastanov]

No description provided.

[codecov-commenter]

Codecov Report

Merging #93 (718f1db) into master (91a9809) will increase coverage by 0.11%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master      #93      +/-   ##
==========================================
+ Coverage   98.06%   98.17%   +0.11%     
==========================================
  Files          10       10              
  Lines         258      274      +16     
==========================================
+ Hits          253      269      +16     
  Misses          5        5              

Files Changed	Coverage Δ
src/ConcurrentSim.jl	100.00% <ø> (ø)
src/resources/containers.jl	100.00% <100.00%> (ø)
src/resources/stores.jl	95.23% <100.00%> (+1.12%)	⬆️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[Krastanov]

This takes care of some of the points discussed in #91.

In particular, it does NOT implement trylock, nor does it deprecate get in favor of pop!.

No functionality is removed, but request, release, put will now show warnings (only in tests, not in usual use). I do not expect these deprecated functions to actually be removed (basically ever).

The failure of the tests on nightly does not seem related to this PR.

I will plan to merge in a few days unless someone requests more time for review.

[Krastanov]

the nightly failures are due to JuliaLang/julia#50710

[Krastanov]

now take! and trylock are also implemented, finishing the rest of #91

#92 and #86 are also now fixed

[hdavid16]

Looks good. So essentially, you are treating resources as if they were Julia channels and extending the base functions for these. Are there any benefits besides renaming the functions? How does this help integrating with other packages if resources are not Channels?

[Krastanov]

Resources/Containers are treated as locks and Stores are treaded as channels. The value is that now I can have a downstream library that can switch between ConcurrentSim and controlling real devices / networks, with almost the same API (the real device / network controller also uses locks and channels). Not everything translates well yet, e.g. I still need to do a lot of testing to ensure multithreading works as expected, etc. but that is a convenient first step.

[Krastanov]

Although, I am not 100% sure on this yet, so I will not be merging it until I have the downstream library actually do all the stuff I described in the previous comment.

[hdavid16]

Sounds like a good use case for this change.

[Krastanov]

@hdavid16 , I undid some of the deprecations. All the new features are still in, but lock/trylock do not exist anymore, rather it is back to request (and a new tryrequest). The reason for undoing this is that lock is supposed to block, unlike request which is to be yielded upon. In the future we might be able to take advantage of the promises/futures objects to simplify this further.

[Krastanov]

I merged without squashing because each commit was a relatively clearly separate steps. In case we need to undo / cherrypick a single change, this should make it a bit easier.