Editar

Compartilhar via

PartyNetwork::DestroyEndpoint

  • Artigo

Queues an asynchronous operation to destroy a local endpoint.

Syntax

PartyError DestroyEndpoint(  
    PartyLocalEndpoint* localEndpoint,  
    void* asyncIdentifier  
)

Parameters

localEndpoint   PartyLocalEndpoint*

The local endpoint to begin destroying.

asyncIdentifier   void*
optional

An optional, app-defined, pointer-sized context value that can be used to associate the completion state change with this call.

Return value

PartyError

c_partyErrorSuccess if the asynchronous operation to destroy the endpoint began, or an error code otherwise. If this method fails, no related state changes will be generated. The human-readable form of the error code can be retrieved via PartyManager::GetErrorMessage().

Remarks

This method queues an asynchronous operation to destroy an endpoint associated with the local device on this network. A PartyDestroyEndpointCompletedStateChange will be provided upon completion of the operation, indicating success or failure. On success, the endpoint is no longer connected to the network or visible to any devices. Memory for the endpoint will remain valid until all state changes referencing the endpoint have been returned to PartyManager::FinishProcessingStateChanges().

If this call returns success, asynchronous endpoint destruction has begun and methods that attempt to send data from this local endpoint to the Party network, such as PartyLocalEndpoint::SendMessage() and PartyLocalEndpoint::FlushMessages(), will fail. Methods that retrieve cached state, such as PartyEndpoint::GetCustomContext() and PartyEndpoint::GetEntityId(), will continue to succeed.

When the local device begins destroying an endpoint, every remote device will be alerted via a PartyEndpointDestroyedStateChange. Those remote devices have the opportunity to send the destructing endpoint any final messages they wish before returning the PartyEndpointDestroyedStateChange to PartyManager::FinishProcessingStateChanges(). By returning the PartyEndpointDestroyedStateChange, the remote device acknowledges the endpoint's destruction and may no longer target the endpoint in PartyLocalEndpoint::SendMessage() calls. Because the endpoint will not be able to complete its destruction on the local device until all remote devices have acknowledged it, it is recommended to return this state change as quickly as possible. If the remote device does not return the PartyEndpointDestroyedStateChange within two seconds, the remote device will automatically acknowledge the endpoint destruction and the endpoint will no longer be targetable in PartyLocalEndpoint::SendMessage() calls. The destructing endpoint can receive PartyEndpointMessageReceivedStateChanges up until all remote devices have acknowledged the endpoint's destruction, which is indicated by a PartyEndpointDestroyedStateChange generated on the local device.

Requirements

Header: Party.h

See also

PartyNetwork
PartyDestroyEndpointCompletedStateChange
PartyEndpointDestroyedStateChange
PartyEndpointMessageReceivedStateChange
PartyLocalEndpoint::SendMessage
PartyEndpoint::GetCustomContext
PartyEndpoint::GetEntityId