leo_mcerl

• Description
• Function Index
• Function Details

The mcerl API.

References

• https://github.com/leo-project/leo_mcerl/blob/master/src/leo_mcerl.erl

Description

The mcerl API

Function Index

delete/2	Delete an object from the leo_mcerl.
get/2	Retrieve an object from the leo_mcerl.
items/1	Retrieve total of cached objects.
put/3	Insert an object into the leo_mcerl.
size/1	Retrieve size of cached objects.
start/1	Launch leo_mcerl.
stop/1	Halt the leo_mcerl.

Function Details

delete/2

delete(Res, Key) -> ok | {error, any()}

• Res = any()
• Key = binary()

Delete an object from the leo_mcerl

get/2

get(Res, Key) -> {ok, binary()} | not_found | {error, any()}

• Res = any()
• Key = binary()

Retrieve an object from the leo_mcerl

items/1

items(Res) -> {ok, integer()} | {error, any()}

• Res = any()

Retrieve total of cached objects

put/3

put(Res, Key, Value) -> ok | {error, any()}

• Res = any()
• Key = binary()
• Value = binary()

Insert an object into the leo_mcerl

size/1

size(Res) -> {ok, integer()} | {error, any()}

• Res = any()

Retrieve size of cached objects

start/1

start(Size) -> {ok, any()}

• Size = integer()

Launch leo_mcerl

stop/1

stop(Res) -> ok | {error, any()}

• Res = any()

Halt the leo_mcerl