Method RemoveFromPayloadStart
RemoveFromPayloadStart<T>()
Get and remove data at the start of the payload reinterpreted to the type T.
Declaration
public T RemoveFromPayloadStart<T>() where T : unmanaged
Returns
Type |
Description |
T |
Extracted data value.
|
Type Parameters
Name |
Description |
T |
Type of the data.
|
Exceptions
Type |
Condition |
ArgumentException |
If there are not enough bytes available at the start of the packet. Only thrown when
collections checks are enabled (i.e. in the editor). Otherwise an error is logged and
a default value is returned.
|
RemoveFromPayloadStart(void*, int)
Fill the provided buffer with the data at the start of the payload, and remove that
data from the packet, decreasing its size accordingly.
Declaration
public void RemoveFromPayloadStart(void* ptr, int size)
Parameters
Type |
Name |
Description |
void* |
ptr |
Pointer to the start of the buffer to fill.
|
int |
size |
Size of the buffer to fill.
|
Exceptions
Type |
Condition |
ArgumentException |
If the buffer is larger than the packet. Only thrown when collections checks are enabled
(i.e. in the editor). Otherwise an error is logged and nothing is copied.
|
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.