Package host.anzo.eossdk.eos.sdk.p2p.options

Class EOS_P2P_SendPacketOptions

java.lang.Object
com.sun.jna.Structure
host.anzo.eossdk.eos.sdk.p2p.options.EOS_P2P_SendPacketOptions
Direct Known Subclasses:
EOS_P2P_SendPacketOptions.ByReference, EOS_P2P_SendPacketOptions.ByValue
@FieldOrder({"ApiVersion","LocalUserId","RemoteUserId","SocketId","Channel","DataLengthBytes","Data","IsAllowDelayedDelivery","Reliability","IsDisableAutoAcceptConnection"}) public class EOS_P2P_SendPacketOptions extends com.sun.jna.Structure
Structure containing information about the data being sent and to which player
Since:
8/21/2023

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    EOS_P2P_SendPacketOptions.ByReference
     
    static class 
    EOS_P2P_SendPacketOptions.ByValue
     

    Nested classes/interfaces inherited from class com.sun.jna.Structure

    com.sun.jna.Structure.FieldOrder, com.sun.jna.Structure.StructField

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    int
    ApiVersion
    API Version: Set this to EOS_P2P_SENDPACKET_API_LATEST.
    byte
    Channel
    Channel associated with this data
    com.sun.jna.Pointer
    Data
    The data to be sent to the RemoteUser
    int
    DataLengthBytes
    The size of the data to be sent to the RemoteUser
    static final int
    EOS_P2P_SENDPACKET_API_LATEST
    The most recent version of the EOS_P2P_SendPacket API.
    EOS_Bool
    IsAllowDelayedDelivery
    If false and we do not already have an established connection to the peer, this data will be dropped
    EOS_Bool
    IsDisableAutoAcceptConnection
    If set to EOS_TRUE, EOS_P2P_SendPacket will not automatically establish a connection with the RemoteUserId and will require explicit calls to EOS_P2P_AcceptConnection first whenever the connection is closed.
    EOS_ProductUserId
    LocalUserId
    The Product User ID of the local user who is sending this packet
    EOS_EPacketReliability
    Reliability
    Setting to control the delivery reliability of this packet
    EOS_ProductUserId
    RemoteUserId
    The Product User ID of the Peer you would like to send a packet to
    EOS_P2P_SocketId.ByReference
    SocketId
    The socket ID for data you are sending in this packet

    Fields inherited from class com.sun.jna.Structure

    ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

  • Constructor Summary

    Constructors
    Constructor
    Description
    EOS_P2P_SendPacketOptions()
     
    EOS_P2P_SendPacketOptions(com.sun.jna.Pointer peer)
     

  • Method Summary

    Methods inherited from class com.sun.jna.Structure

    allocateMemory, allocateMemory, autoAllocate, autoRead, autoRead, autoWrite, autoWrite, cacheTypeInfo, calculateSize, clear, createFieldsOrder, createFieldsOrder, createFieldsOrder, createFieldsOrder, dataEquals, dataEquals, ensureAllocated, equals, fieldOffset, getAutoRead, getAutoWrite, getFieldList, getFieldOrder, getFields, getNativeAlignment, getNativeSize, getNativeSize, getPointer, getStringEncoding, getStructAlignment, hashCode, newInstance, newInstance, read, readField, readField, setAlignType, setAutoRead, setAutoSynch, setAutoWrite, setStringEncoding, size, sortFields, toArray, toArray, toString, toString, useMemory, useMemory, write, writeField, writeField, writeField

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • EOS_P2P_SENDPACKET_API_LATEST

      public static final int EOS_P2P_SENDPACKET_API_LATEST
      The most recent version of the EOS_P2P_SendPacket API.
      See Also:

    • ApiVersion

      public int ApiVersion
      API Version: Set this to EOS_P2P_SENDPACKET_API_LATEST.

    • LocalUserId

      public EOS_ProductUserId LocalUserId
      The Product User ID of the local user who is sending this packet

    • RemoteUserId

      public EOS_ProductUserId RemoteUserId
      The Product User ID of the Peer you would like to send a packet to

    • SocketId

      public EOS_P2P_SocketId.ByReference SocketId
      The socket ID for data you are sending in this packet

    • Channel

      public byte Channel
      Channel associated with this data

    • DataLengthBytes

      public int DataLengthBytes
      The size of the data to be sent to the RemoteUser

    • Data

      public com.sun.jna.Pointer Data
      The data to be sent to the RemoteUser

    • IsAllowDelayedDelivery

      public EOS_Bool IsAllowDelayedDelivery
      If false and we do not already have an established connection to the peer, this data will be dropped

    • Reliability

      public EOS_EPacketReliability Reliability
      Setting to control the delivery reliability of this packet

    • IsDisableAutoAcceptConnection

      public EOS_Bool IsDisableAutoAcceptConnection
      If set to EOS_TRUE, EOS_P2P_SendPacket will not automatically establish a connection with the RemoteUserId and will require explicit calls to EOS_P2P_AcceptConnection first whenever the connection is closed. If set to EOS_FALSE, EOS_P2P_SendPacket will automatically accept and start the connection any time it is called and the connection is not already open.

  • Constructor Details

    • EOS_P2P_SendPacketOptions

      public EOS_P2P_SendPacketOptions()

    • EOS_P2P_SendPacketOptions

      public EOS_P2P_SendPacketOptions(com.sun.jna.Pointer peer)