Skip to content

Commit

Permalink
refactor: remove references to gen_server timeouts
Browse files Browse the repository at this point in the history
  • Loading branch information
thalesmg committed Jun 6, 2024
1 parent 0c27179 commit 65b8061
Show file tree
Hide file tree
Showing 2 changed files with 69 additions and 139 deletions.
11 changes: 1 addition & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,10 @@ Key = "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr
```

## Calling Azure services
Almost each azure services request has three corresponding functions in ```erlazure``` module, the first has minimal set of parameters, the second has additionaly list of ```Options``` and the third has additionaly ```Timeout``` parameter.
Almost each azure services request has three corresponding functions in ```erlazure``` module, the first has minimal set of parameters, the second has additionaly list of ```Options```.

```Options``` as the name states is list of options supported by this azure services request, each options is tuple ```{OptionName, OptionValue}``` where ```OptionName``` is atom and ```OptionValue``` can be of any type, option is passed either as a header or as a query string parameter.

```Timeout``` is number of milliseconds to wait for a reply from erlazure, infinity value is not supported. Note, that this is gen_server call timeout and isn't http request timeout (it's set to infinity by default) or azure service request timeout (you can specify it by sending option ```{timeout, _Timeout}```). By default timeout is set to 30 seconds.

For a list of supported options for each azure service request please consult msdn documentation.

## Examples
Expand All @@ -80,13 +78,6 @@ For a list of supported options for each azure service request please consult ms
{ok, Binary} = file:read("/path/to/some/small/file"),
{ok, created} = erlazure:put_block_blob(State, "uploads", "test_upload.file", Binary).
```
### Upload block blob with timeout set
Uploads block blob and waits no longer than 15 seconds for erlazure to finish the upload
```
{ok, State} = erlazure:new("storage", "2o4b4tHpoWifLU+BlyzsIG1VtlO9LgBRFyl1qLw/+w9/ZszSxKGIK8JYac/UEJp5r8HKgiOiG8YTqGS9otAYWA=="),
{ok, Binary} = file:read("/path/to/some/other/file"),
{ok, created} = erlazure:put_block_blob(State, "uploads", "test_upload2.file", Binary, [], 15000).
```

### Get 20 messages from a queue
Retrieves max 20 messages from a queue
Expand Down
Loading

0 comments on commit 65b8061

Please sign in to comment.