Top Description Inners Fields Constructors Methods
org.lwjgl.system.linux

public Class Sockaddr

extends Struct<Sockaddr>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct sockaddr
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure describing a generic socket address.

Layout


struct sockaddr {
    sa_family_t sa_family;
    char sa_data[14];
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
Sockaddr.Buffer

An array of Sockaddr structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
SA_DATA

The struct member offsets.

public static final int
SA_FAMILY

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
Sockaddr(long address, ByteBuffer container)

public
Sockaddr(ByteBuffer container)

Creates a Sockaddr instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static Sockaddr
calloc()

Returns a new Sockaddr instance allocated with memCalloc.

public static Sockaddr.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new Sockaddr.Buffer instance allocated with memCalloc.

public static Sockaddr
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new Sockaddr instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static Sockaddr.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new Sockaddr.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

protected Sockaddr
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static Sockaddr
create()

Returns a new Sockaddr instance allocated with BufferUtils.

public static Sockaddr
create(long address)

Returns a new Sockaddr instance for the specified memory address.

public static Sockaddr.Buffer
create(int
the buffer capacity
capacity
)

Returns a new Sockaddr.Buffer instance allocated with BufferUtils.

public static Sockaddr.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a Sockaddr.Buffer instance at the specified memory.

public static Sockaddr
createSafe(long address)

Like create, but returns null if address is NULL.

public static Sockaddr.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public static Sockaddr
malloc()

Returns a new Sockaddr instance allocated with memAlloc.

public static Sockaddr.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new Sockaddr.Buffer instance allocated with memAlloc.

public static Sockaddr
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new Sockaddr instance allocated on the specified MemoryStack.

public static Sockaddr.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new Sockaddr.Buffer instance allocated on the specified MemoryStack.

public static ByteBuffer
nsa_data(long struct)

Unsafe version of sa_data.

public static byte
nsa_data(long struct, int index)

Unsafe version of sa_data.

public static void
nsa_data(long struct, ByteBuffer value)

Unsafe version of sa_data.

public static void
nsa_data(long struct, int index, byte value)

Unsafe version of sa_data.

public static short
nsa_family(long struct)

Unsafe version of sa_family.

public static void
nsa_family(long struct, short value)

Unsafe version of sa_family.

public ByteBuffer
sa_data()

address data

public byte
sa_data(int index)

address data

public Sockaddr
sa_data(ByteBuffer value)

Copies the specified ByteBuffer to the sa_data field.

public Sockaddr
sa_data(int index, byte value)

Sets the specified value at the specified index of the sa_data field.

public short
sa_family()

address family and length

public Sockaddr
sa_family(short value)

Sets the specified value to the sa_family field.

public Sockaddr
set(short sa_family, ByteBuffer sa_data)

Initializes this struct with the specified values.

public Sockaddr

Returns:

this struct
set
(Sockaddr
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

SA_DATAback to summary
public static final int SA_DATA

The struct member offsets.

SA_FAMILYback to summary
public static final int SA_FAMILY

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

Sockaddrback to summary
protected Sockaddr(long address, ByteBuffer container)
Sockaddrback to summary
public Sockaddr(ByteBuffer container)

Creates a Sockaddr instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

The created instance holds a strong reference to the container object.

Method Detail

callocback to summary
public static Sockaddr calloc()

Returns a new Sockaddr instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static Sockaddr.Buffer calloc(int capacity)

Returns a new Sockaddr.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static Sockaddr calloc(MemoryStack stack)

Returns a new Sockaddr instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static Sockaddr.Buffer calloc(int capacity, MemoryStack stack)

Returns a new Sockaddr.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected Sockaddr create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static Sockaddr create()

Returns a new Sockaddr instance allocated with BufferUtils.

createback to summary
public static Sockaddr create(long address)

Returns a new Sockaddr instance for the specified memory address.

createback to summary
public static Sockaddr.Buffer create(int capacity)

Returns a new Sockaddr.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static Sockaddr.Buffer create(long address, int capacity)

Create a Sockaddr.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static Sockaddr createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static Sockaddr.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static Sockaddr malloc()

Returns a new Sockaddr instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static Sockaddr.Buffer malloc(int capacity)

Returns a new Sockaddr.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static Sockaddr malloc(MemoryStack stack)

Returns a new Sockaddr instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static Sockaddr.Buffer malloc(int capacity, MemoryStack stack)

Returns a new Sockaddr.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nsa_databack to summary
public static ByteBuffer nsa_data(long struct)

Unsafe version of sa_data.

nsa_databack to summary
public static byte nsa_data(long struct, int index)

Unsafe version of sa_data.

nsa_databack to summary
public static void nsa_data(long struct, ByteBuffer value)

Unsafe version of sa_data.

nsa_databack to summary
public static void nsa_data(long struct, int index, byte value)

Unsafe version of sa_data.

nsa_familyback to summary
public static short nsa_family(long struct)

Unsafe version of sa_family.

nsa_familyback to summary
public static void nsa_family(long struct, short value)

Unsafe version of sa_family.

sa_databack to summary
public ByteBuffer sa_data()

address data

Annotations
@NativeType:char[14]
sa_databack to summary
public byte sa_data(int index)

address data

Annotations
@NativeType:char
sa_databack to summary
public Sockaddr sa_data(ByteBuffer value)

Copies the specified ByteBuffer to the sa_data field.

sa_databack to summary
public Sockaddr sa_data(int index, byte value)

Sets the specified value at the specified index of the sa_data field.

sa_familyback to summary
public short sa_family()

address family and length

Annotations
@NativeType:sa_family_t
sa_familyback to summary
public Sockaddr sa_family(short value)

Sets the specified value to the sa_family field.

setback to summary
public Sockaddr set(short sa_family, ByteBuffer sa_data)

Initializes this struct with the specified values.

setback to summary
public Sockaddr set(Sockaddr src)

Copies the specified struct data to this struct.

Parameters
src:Sockaddr

the source struct

Returns:Sockaddr

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
org.lwjgl.system.linux back to summary

public Class Sockaddr.Buffer

extends StructBuffer<Sockaddr, Sockaddr.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of Sockaddr structs.

Field Summary

Modifier and TypeField and Description
private static final Sockaddr

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new Sockaddr.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected Sockaddr
public ByteBuffer

Returns:

a ByteBuffer view of the Sockaddr#sa_data field.
sa_data
()

public byte

Returns:

the value at the specified index of the Sockaddr#sa_data field.
sa_data
(int index)

public Sockaddr.Buffer
sa_data(ByteBuffer value)

Copies the specified ByteBuffer to the Sockaddr#sa_data field.

public Sockaddr.Buffer
sa_data(int index, byte value)

Sets the specified value at the specified index of the Sockaddr#sa_data field.

public short

Returns:

the value of the Sockaddr#sa_family field.
sa_family
()

public Sockaddr.Buffer
sa_family(short value)

Sets the specified value to the Sockaddr#sa_family field.

protected Sockaddr.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final Sockaddr ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new Sockaddr.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by Sockaddr#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected Sockaddr getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
sa_databack to summary
public ByteBuffer sa_data()
Returns:ByteBuffer

a ByteBuffer view of the Sockaddr#sa_data field.

Annotations
@NativeType:char[14]
sa_databack to summary
public byte sa_data(int index)
Returns:byte

the value at the specified index of the Sockaddr#sa_data field.

Annotations
@NativeType:char
sa_databack to summary
public Sockaddr.Buffer sa_data(ByteBuffer value)

Copies the specified ByteBuffer to the Sockaddr#sa_data field.

sa_databack to summary
public Sockaddr.Buffer sa_data(int index, byte value)

Sets the specified value at the specified index of the Sockaddr#sa_data field.

sa_familyback to summary
public short sa_family()
Returns:short

the value of the Sockaddr#sa_family field.

Annotations
@NativeType:sa_family_t
sa_familyback to summary
public Sockaddr.Buffer sa_family(short value)

Sets the specified value to the Sockaddr#sa_family field.

selfback to summary
protected Sockaddr.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override