Skip to content

Platform docs cleanup #482

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Apr 10, 2018
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/reference/api/platform/ATCmdParser.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## ATCmdParser

ATCmdParser is an Mbed OS compatible AT command parser. AT commands are instructions used to communicate with a communication device such as a modem, phone or Wi-Fi module. Each command is a text string in ASCII format, and every command starts with "AT" characters followed by a command specifying the operation to be carried out.
ATCmdParser is an Mbed OS compatible AT command parser and serializer. AT commands are instructions used to communicate with a communication device such as a modem, phone or Wi-Fi module. Each command is a text string in ASCII format, and every command starts with "AT" characters followed by a command specifying the operation to be carried out.

The ATCmdParser class in Mbed OS implements functionality to send and receive AT commands to devices capable of communicating using AT commands. The ATCmdParser internally uses the driver for the communication channel to talk to the device. It expects the driver to implement the FileHandle interface to invoke the functions on the driver.

Expand Down
153 changes: 153 additions & 0 deletions docs/reference/api/platform/Callback.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,156 @@ Here is an example that uses everything discussed in the [introduction to callba

- [Platform overview](/docs/development/reference/platform.html).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This and Intro + related content should now be deleted

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I'll do that.

- [Introduction to callbacks](/docs/development/reference/platform.html#callbacks).

#### Create callbacks

First, you need to understand the syntax of the Callback type. The Callback type is a templated type parameterized by a C++ function declaration:

``` c++
// Callback</*return type*/(/*parameters*/)> cb;
Callback<int(float)> cb; // A callback that takes in a float and returns an int
Callback<void(float)> cb; // A callback that takes in a float and returns nothing
Callback<int()> cb; // A callback that takes in nothing and returns an int
Callback<void(float, float)> cb; // A callback that takes in two floats and returns nothing
```

You can create a Callback directly from a C function or function pointer with the same type:

``` c++
void dosomething(int) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great to move the content around but this still violates the no foo/bar rule imo. Make sure to keep another task to make the example useful or tangible

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I'd rather just do that now.

// do something
}

Callback<void(int)> cb(dosomething);
```

If an API provides a function that takes in a callback, you can pass in a C function or function pointer with the same type:

``` c++
class ADC {
// ADC can pass an analog value to the callback
void attach(Callback<void(float)> cb);
};

void dosomething(float f) {
// do something
}

ADC adc;
adc.attach(dosomething);
```

But what about state? The Callback type also supports passing a state pointer for a function. This state can be either a pointer to an object that is passed to a member function, or a pointer passed to a C-style function.

Because this form of creating Callbacks requires two arguments, you need to create the Callback explicitly using the Callback constructor. The Callback also comes with the lowercase callback function, which creates callbacks based on the arguments type and avoids the need to repeat the template type.

You can create a callback with a member function.

``` c++
class Thing {
int state;
void catinthehat(int i) {
state = // do something
}
}

// We can create a Callback with the Callback constructor
Thing thing1;
adc.attach(Callback<void(int)>(&thing1, &Thing::catinthehat));

// Or we can create a Callback with the callback function to avoid repeating ourselves
Thing thing2;
adc.attach(callback(&thing2, &Thing::catinthehat));
```

Or you can pass the state to a C-style function.

``` c++
struct thing_t {
int state;
}

void catinthehat(thing_t *thing, float f) {
thing->state = // do something
}

// We can create a Callback with the Callback constructor
thing_t thing1;
adc.attach(Callback<void(int)>(catinthehat, &thing1));

// Or we can create a Callback with the callback function to avoid repeating ourselves
thing_t thing2;
adc.attach(callback(catinthehat, &thing2));
```

<span class="notes">**Note:** This state is restricted to a single pointer. This means you can’t bind both an object and argument to a callback.</span>

``` c++
// Does not work
adc.attach(callback(&thing, &Thing::dosomething, &arg));
```

If you need to pass multiple arguments to a callback and you can’t store the arguments in the class, you can create a struct that contains all of the arguments and pass a pointer to that. However, you need to handle the memory allocation yourself.

``` c++
// Create a struct that contains all of the state needed for “dosomething”
struct dosomething_arguments {
Thing *thing;
int arg1;
int arg2;
};

// Create a function that calls “dosomething” with the arguments
void dosomething_with_arguments(struct dosomething_arguments *args) {
args->thing->dosomething(args->arg1, args->arg2);
}


// Allocate arguments and pass to callback
struct dosomething_arguments args = { &thing, arg1, arg2 };
adc.attach(callback(dosomething_with_arguments, &args)); // yes
```

#### Call callbacks

Callbacks overload the function call operator, so you can call a Callback like you would a normal function:

```c++
void callme(Callback<void(float)> cb) {
cb(1.0f);
}
```

The only thing to watch out for is that the Callback type has a null Callback, just like a null function pointer. Uninitialized callbacks are null and assert if you call them. If you want a call to always succeed, you need to check if it is null first.

``` c++
void callmemaybe(Callback<void(float)> cb) {
if (cb) {
cb(1.0f);
}
}
```

The Callback class is what’s known in C++ as a “Concrete Type”. That is, the Callback class is lightweight enough to be passed around like an int, pointer or other primitive type.

```c++
class Thing {
private:
Callback<void(int)> _cb;

public:
void attach(Callback<void(int)> cb) {
_cb = cb
}

void dothething(int arg) {
If (_cb) {
_cb(arg);
}
}
}
```

<h4 id="the-importance-of-state">The importance of state</h4>

A callback is a user provided function that a user may pass to an API. The callback allows the API to execute the user’s code in its own context. You can find more information on how to use callbacks in the [technical callback documentation](/docs/development/reference/callback.html).
Loading