diff options
Diffstat (limited to 'Impostor-dev/src/Impostor.Api/Net/Messages/IMessageWriterProvider.cs')
-rw-r--r-- | Impostor-dev/src/Impostor.Api/Net/Messages/IMessageWriterProvider.cs | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/Impostor-dev/src/Impostor.Api/Net/Messages/IMessageWriterProvider.cs b/Impostor-dev/src/Impostor.Api/Net/Messages/IMessageWriterProvider.cs new file mode 100644 index 0000000..f398939 --- /dev/null +++ b/Impostor-dev/src/Impostor.Api/Net/Messages/IMessageWriterProvider.cs @@ -0,0 +1,16 @@ +namespace Impostor.Api.Net.Messages +{ + public interface IMessageWriterProvider + { + /// <summary> + /// Retrieves a <see cref="IMessageWriter"/> from the internal pool. + /// Make sure to call <see cref="IMessageWriter.Dispose"/> when you are done! + /// </summary> + /// <param name="sendOption"> + /// Whether to send the message as <see cref="MessageType.Reliable"/> or <see cref="MessageType.Unreliable"/>. + /// Reliable packets will ensure delivery while unreliable packets may be lost. + /// </param> + /// <returns>A <see cref="IMessageWriter"/> from the pool.</returns> + IMessageWriter Get(MessageType sendOption = MessageType.Unreliable); + } +} |