Package org.jruby.ext.socket

Class RubyBasicSocket

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.RubyIO

org.jruby.ext.socket.RubyBasicSocket

All Implemented Interfaces:

Closeable, Flushable, Serializable, AutoCloseable, Cloneable, Comparable<IRubyObject>, InstanceVariables, InternalVariables, IRubyObject, CoreObjectType, IOEncodable

Direct Known Subclasses:

RubyIPSocket, RubySocket, RubyUNIXSocket

public class RubyBasicSocket
extends RubyIO

Implementation of the BasicSocket class from Ruby.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RubyBasicSocket.LibC
protected static class	RubyBasicSocket.ReceiveTuple

Nested classes/interfaces inherited from class org.jruby.RubyIO

RubyIO.Sysopen

Nested classes/interfaces inherited from class org.jruby.RubyObject

RubyObject.Data

Nested classes/interfaces inherited from class org.jruby.RubyBasicObject

RubyBasicObject.Finalizer

Nested classes/interfaces inherited from interface org.jruby.util.io.IOEncodable

IOEncodable.ConvConfig

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	doNotReverseLookup
private static final ByteList	FORMAT_SMALL_I
(package private) static final String[]	libnames
protected MulticastStateManager	multicastStateManager
(package private) static final RubyBasicSocket.LibC	SOCKOPT

Fields inherited from class org.jruby.RubyIO

CLOSED_STREAM_MSG, FD_CLOEXEC, openFile, PARAGRAPH_SEPARATOR, popenSpecial

Fields inherited from class org.jruby.RubyObject

IVAR_INSPECTING_OBJECT_ALLOCATOR, OBJECT_ALLOCATOR, REIFYING_OBJECT_ALLOCATOR

Fields inherited from class org.jruby.RubyBasicObject

ALL_F, BASICOBJECT_ALLOCATOR, COMPARE_BY_IDENTITY_F, ERR_INSECURE_SET_INST_VAR, FALSE_F, FL_USHIFT, flags, FROZEN_F, IS_OVERLAID_F, metaClass, NEVER, NIL_F, REFINED_MODULE_F, STAMP_OFFSET, TAINTED_F, UNDEF, UNTRUST_F, USER0_F, USER1_F, USER2_F, USER3_F, USER4_F, USER5_F, USER6_F, USER7_F, USER8_F, USER9_F, USERA_F, VAR_TABLE_OFFSET, varTable, varTableStamp

Fields inherited from interface org.jruby.runtime.builtin.IRubyObject

NULL_ARRAY

Constructor Summary

Constructors

Constructor	Description
RubyBasicSocket(Ruby runtime, RubyClass type)

Method Summary

Modifier and Type	Method	Description
protected IRubyObject	addrFor(ThreadContext context, InetSocketAddress addr, boolean reverse)
protected boolean	asBoolean(ThreadContext context, IRubyObject val)
private static int	asNumber(ThreadContext context, IRubyObject val)
protected static String	bindContextMessage(IRubyObject host, int port)
IRubyObject	close_read(ThreadContext context)
IRubyObject	close_write(ThreadContext context)
private IRubyObject	closeHalf(ThreadContext context, int closeHalf)
(package private) static void	createBasicSocket(Ruby runtime)
static IRubyObject	do_not_reverse_lookup(IRubyObject recv)	Deprecated.
static IRubyObject	do_not_reverse_lookup(ThreadContext context, IRubyObject recv)
IRubyObject	do_not_reverse_lookup19(ThreadContext context)
boolean	doNotReverseLookup(ThreadContext context)
protected ByteList	doRead(ThreadContext context, ByteBuffer buffer)
protected final ByteList	doReadNonblock(ThreadContext context, ByteBuffer buffer, boolean exception)
private IRubyObject	doSend(ThreadContext context, IRubyObject _mesg, IRubyObject _flags, IRubyObject _to)
(package private) static boolean	extractExceptionArg(ThreadContext context, IRubyObject opts)
static IRubyObject	for_fd(ThreadContext context, IRubyObject _klass, IRubyObject _fileno)
protected InetSocketAddress	getInetRemoteSocket()
protected InetSocketAddress	getInetSocketAddress()
private Channel	getOpenChannel()
IRubyObject	getpeereid(ThreadContext context)
IRubyObject	getpeername()	Deprecated.
IRubyObject	getpeername(ThreadContext context)
protected SocketAddress	getRemoteSocket()
protected SocketAddress	getSocketAddress()
IRubyObject	getsockname()	Deprecated.
IRubyObject	getsockname(ThreadContext context)
protected IRubyObject	getSocknameCommon(ThreadContext context, String caller)
IRubyObject	getsockopt(IRubyObject lev, IRubyObject optname)	Deprecated.
IRubyObject	getsockopt(ThreadContext context, IRubyObject _level, IRubyObject _opt)
protected jnr.unixsocket.UnixSocketAddress	getUnixRemoteSocket()
protected jnr.unixsocket.UnixSocketAddress	getUnixSocketAddress()
private IRubyObject	handleReturnBytes(Ruby runtime, ByteList bytes, IRubyObject str, String exMessage, boolean exception)
protected void	initSocket(ChannelFD fd)
private void	joinMulticastGroup(IRubyObject val)
IRubyObject	local_address(ThreadContext context)
protected static ChannelFD	newChannelFD(Ruby runtime, Channel channel)
IRubyObject	read_nonblock(ThreadContext context, IRubyObject[] args)
IRubyObject	recv(IRubyObject[] args)	Deprecated.
IRubyObject	recv(ThreadContext context, IRubyObject length)
IRubyObject	recv(ThreadContext context, IRubyObject[] args)
private IRubyObject	recv(ThreadContext context, IRubyObject length, RubyString str, IRubyObject flags)
IRubyObject	recv_nonblock(ThreadContext context, IRubyObject[] args)
IRubyObject	recvmsg(ThreadContext context, IRubyObject[] args)
IRubyObject	recvmsg_nonblock(ThreadContext context, IRubyObject[] args)
IRubyObject	remote_address(ThreadContext context)
IRubyObject	send(ThreadContext context, IRubyObject _mesg, IRubyObject _flags)
IRubyObject	send(ThreadContext context, IRubyObject _mesg, IRubyObject _flags, IRubyObject _to)
IRubyObject	sendmsg(ThreadContext context, IRubyObject[] args)
IRubyObject	sendmsg_nonblock(ThreadContext context, IRubyObject[] args)
static IRubyObject	set_do_not_reverse_lookup(IRubyObject recv, IRubyObject flag)	Deprecated.
static IRubyObject	set_do_not_reverse_lookup(ThreadContext context, IRubyObject recv, IRubyObject flag)
IRubyObject	set_do_not_reverse_lookup19(ThreadContext context, IRubyObject flag)
IRubyObject	setsockopt(IRubyObject lev, IRubyObject optname, IRubyObject val)	Deprecated.
IRubyObject	setsockopt(ThreadContext context, IRubyObject option)
IRubyObject	setsockopt(ThreadContext context, IRubyObject _level, IRubyObject _opt, IRubyObject val)
IRubyObject	shutdown(ThreadContext context, IRubyObject[] args)
private static IRubyObject	shutdownInternal(ThreadContext context, OpenFile fptr, int how)
(package private) static RuntimeException	sockerr(Ruby runtime, String msg, Exception cause)
private static int	stringAsNumber(ThreadContext context, IRubyObject val)
private boolean	validTcpSockOpt(int intOpt)

Methods inherited from class org.jruby.RubyIO

addBlockingThread, advise, autoclose, autoclose_set, binmode, binread, binwrite, bytes, chars, chars19, checkExecEnv, checkExecOptions, checkLength, checkPopenOptions, checkSpawnOptions, cloexecOpen, close, close, close_on_exec_p, close_on_exec_set, closed_p, codepoints, convertToIO, copy_stream, createIOClass, doRead, doReadNonblock, doWriteNonblock, each, each, each, each, each, each_byte, each_byteInternal, each_char, each_char19, each_charInternal, each_codepoint, each_line, each_line, each_line, each_line, each_line, ensureYieldClose, ensureYieldClosePipes, eof_p, external_encoding, failIfDirectory, fcntl, fcntl, fileno, flush, flush, flushRaw, for_fd, foreach, fsync, getBlocking, getBOM, getbyte, getByte, getc, getc, getc19, getChannel, getEcflags, getEcopts, getEnc, getEnc2, getInputEncoding, getInStream, getIOModes, getIOModesIntFromString, getline, getline, getline, getline, getline, getline, getNativeClassIndex, getOpenFile, getOpenFileChecked, getOpenFileInitialized, getOutStream, getReadEncoding, gets, gets, gets, gets, getSync, GetWriteIO, initialize, initialize, initialize, initialize_copy, inspect, internal_encoding, ioClose, ioctl, ioOpen, ioOpen, ioStaticWrite, isAutoclose, isClosed, lineno, lineno_set, lines, lines19, MakeOpenFile, newInstance, newIO, newIOOptions, newIOOptions, newIOOptions, newIOOptions, newIOOptions, newModeFlags, newModeFlags, newModeFlags, obliterateProcess, op_append, op_binmode, open, parseIOOptions, pid, pipe, pipe, pipe19, pipe19, pipe19, popen, popen3, popen4, popenSpecial, pos, pos_set, pread, pread, prepStdio, prepStdio, print, print, printf, putc, putc, puts, puts, puts, puts, puts, puts, puts0, puts1, puts2, puts3, pwrite, rbIoClose, read, read, read, read, read, read, read, read19, readbyte, readchar, readchar, readline, readline, readline, readlines, readlines, readlines, readlines, readlines, readlines, readlines19, readlines19, readpartial, removeBlockingThread, reopen, reopenIO, rewind, seek, seek, seek, select, select_static, set_encoding, set_encoding, set_encoding, setAscii8bitBinmode, setAutoclose, setBlocking, setBOM, setEcflags, setEcopts, setEnc, setEnc2, setEncoding, setSync, stat, sync, sync_set, sysopen, sysopen, sysopen, sysopen19, sysread, sysseek, syswrite, to_io, toJava, toString, tryConvert, tty_p, ungetbyte, ungetc, updateIOOptionsFromOptions, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write_nonblock, writeStatic

Methods inherited from class org.jruby.RubyObject

attachToObjectSpace, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, convertToType, createObjectClass, dig, dig1, dig2, eqlInternal, equalInternal, equals, hashCode, inspect, op_eqq, puts, specificEval, toRubyString

Methods inherited from class org.jruby.RubyBasicObject

addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callSuper, checkArrayType, checkCallMethod, checkCallMethod, checkFrozen, checkStringType, checkStringType19, compareTo, convertToArray, convertToFloat, convertToHash, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, copySpecialInstanceVariables, createBasicObjectClass, dataGetStruct, dataGetStructChecked, dataWrapStruct, decode, display, dup, ensureInstanceVariablesSettable, eql, eql_p, equal_p, equal_p19, evalUnder, extend, fastGetInstanceVariable, fastGetInternalVariable, fastHasInstanceVariable, fastHasInternalVariable, fastSetInstanceVariable, fastSetInternalVariable, freeze, frozen_p, getFFIHandle, getFlag, getInstanceEvalClass, getInstanceVariable, getInstanceVariableList, getInstanceVariableNameList, getInstanceVariables, getInternalVariable, getInternalVariables, getJavaClass, getMetaClass, getMetaClass, getNativeHandle, getNativeTypeIndex, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getSingletonClassCloneAndAttach, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hash, hashyInspect, hasInstanceVariable, hasInstanceVariables, hasInternalVariable, hasVariables, id, infectBy, initialize, initialize19, inspectHashCode, instance_eval, instance_eval, instance_eval, instance_eval, instance_eval19, instance_eval19, instance_eval19, instance_eval19, instance_exec, instance_exec19, instance_of_p, instance_variable_defined_p, instance_variable_get, instance_variable_set, instance_variables, instance_variables19, isBuiltin, isClass, isFalse, isFrozen, isImmediate, isModule, isNil, isSpecialConst, isSpecialObject, isTaint, isTrue, isUntrusted, kind_of_p, makeMetaClass, method, method_missing, method_missing19, method19, methods, methods, methods19, nil_p, nonFixnumHashCode, OBJ_INIT_COPY, objInitCopy, op_cmp, op_equal, op_equal_19, op_match, op_match19, op_not, op_not_equal, op_not_match, private_methods, private_methods19, protected_methods, protected_methods19, public_methods, public_methods19, rbClone, rbClone, rbInspect, remove_instance_variable, removeFinalizers, removeInstanceVariable, removeInternalVariable, respond_to_p, respond_to_p, respond_to_p19, respond_to_p19, respondsTo, respondsToMissing, respondsToMissing, send, send, send, send, send, send19, send19, send19, send19, setFFIHandle, setFlag, setFrozen, setInstanceVariable, setInternalVariable, setMetaClass, setNativeHandle, setTaint, setUntrusted, setVariable, singleton_method, singleton_method_added, singleton_method_added19, singleton_method_removed, singleton_method_removed19, singleton_method_undefined, singleton_method_undefined19, singleton_methods, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, taint, tainted_p, testFrozen, testFrozen, to_a, to_a, to_s, trust, type, type_deprecated, untaint, untrust, untrusted_p, validateInstanceVariable, validateInstanceVariable, validateInstanceVariable, variableTableContains, variableTableFastContains, variableTableFastFetch, variableTableFastStore, variableTableFetch, variableTableRemove, variableTableStore, variableTableSync, yieldUnder, yieldUnder

Methods inherited from class java.lang.Object

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

Field Details

libnames

static final String[] libnames

SOCKOPT

static final RubyBasicSocket.LibC SOCKOPT

FORMAT_SMALL_I

private static final ByteList FORMAT_SMALL_I

multicastStateManager

protected MulticastStateManager multicastStateManager

doNotReverseLookup

private boolean doNotReverseLookup

Constructor Details

RubyBasicSocket

public RubyBasicSocket(Ruby runtime,
 RubyClass type)

Method Details

createBasicSocket

static void createBasicSocket(Ruby runtime)

for_fd

public static IRubyObject for_fd(ThreadContext context,
 IRubyObject _klass,
 IRubyObject _fileno)

do_not_reverse_lookup19

public IRubyObject do_not_reverse_lookup19(ThreadContext context)

set_do_not_reverse_lookup19

public IRubyObject set_do_not_reverse_lookup19(ThreadContext context,
 IRubyObject flag)

do_not_reverse_lookup

public static IRubyObject do_not_reverse_lookup(ThreadContext context,
 IRubyObject recv)

set_do_not_reverse_lookup

public static IRubyObject set_do_not_reverse_lookup(ThreadContext context,
 IRubyObject recv,
 IRubyObject flag)

send

public IRubyObject send(ThreadContext context,
 IRubyObject _mesg,
 IRubyObject _flags)

send

public IRubyObject send(ThreadContext context,
 IRubyObject _mesg,
 IRubyObject _flags,
 IRubyObject _to)

doSend

private IRubyObject doSend(ThreadContext context,
 IRubyObject _mesg,
 IRubyObject _flags,
 IRubyObject _to)

recv

public IRubyObject recv(ThreadContext context,
 IRubyObject length)

recv

public IRubyObject recv(ThreadContext context,
 IRubyObject[] args)

recv

private IRubyObject recv(ThreadContext context,
 IRubyObject length,
 RubyString str,
 IRubyObject flags)

recv_nonblock

public IRubyObject recv_nonblock(ThreadContext context,
 IRubyObject[] args)

handleReturnBytes

private IRubyObject handleReturnBytes(Ruby runtime,
 ByteList bytes,
 IRubyObject str,
 String exMessage,
 boolean exception)

read_nonblock

public IRubyObject read_nonblock(ThreadContext context,
 IRubyObject[] args)

Overrides:

read_nonblock in class RubyIO

getsockopt

public IRubyObject getsockopt(ThreadContext context,
 IRubyObject _level,
 IRubyObject _opt)

setsockopt

public IRubyObject setsockopt(ThreadContext context,
 IRubyObject option)

setsockopt

public IRubyObject setsockopt(ThreadContext context,
 IRubyObject _level,
 IRubyObject _opt,
 IRubyObject val)

getsockname

public IRubyObject getsockname(ThreadContext context)

getpeername

public IRubyObject getpeername(ThreadContext context)

getpeereid

public IRubyObject getpeereid(ThreadContext context)

local_address

public IRubyObject local_address(ThreadContext context)

remote_address

public IRubyObject remote_address(ThreadContext context)

shutdown

public IRubyObject shutdown(ThreadContext context,
 IRubyObject[] args)

close_write

public IRubyObject close_write(ThreadContext context)

Overrides:

close_write in class RubyIO

close_read

public IRubyObject close_read(ThreadContext context)

Overrides:

close_read in class RubyIO

closeHalf

private IRubyObject closeHalf(ThreadContext context,
 int closeHalf)

sendmsg

public IRubyObject sendmsg(ThreadContext context,
 IRubyObject[] args)

sendmsg_nonblock

public IRubyObject sendmsg_nonblock(ThreadContext context,
 IRubyObject[] args)

recvmsg

public IRubyObject recvmsg(ThreadContext context,
 IRubyObject[] args)

recvmsg_nonblock

public IRubyObject recvmsg_nonblock(ThreadContext context,
 IRubyObject[] args)

doRead

protected ByteList doRead(ThreadContext context,
 ByteBuffer buffer)

doReadNonblock

protected final ByteList doReadNonblock(ThreadContext context,
 ByteBuffer buffer,
 boolean exception)

joinMulticastGroup

private void joinMulticastGroup(IRubyObject val)
                         throws IOException,
BadDescriptorException

Throws:

IOException

BadDescriptorException

getInetSocketAddress

protected InetSocketAddress getInetSocketAddress()

getInetRemoteSocket

protected InetSocketAddress getInetRemoteSocket()

getUnixSocketAddress

protected jnr.unixsocket.UnixSocketAddress getUnixSocketAddress()

getUnixRemoteSocket

protected jnr.unixsocket.UnixSocketAddress getUnixRemoteSocket()

getSocketAddress

protected SocketAddress getSocketAddress()

getRemoteSocket

protected SocketAddress getRemoteSocket()

getSocknameCommon

protected IRubyObject getSocknameCommon(ThreadContext context,
 String caller)

validTcpSockOpt

private boolean validTcpSockOpt(int intOpt)

shutdownInternal

private static IRubyObject shutdownInternal(ThreadContext context,
 OpenFile fptr,
 int how)

doNotReverseLookup

public boolean doNotReverseLookup(ThreadContext context)

newChannelFD

protected static ChannelFD newChannelFD(Ruby runtime,
 Channel channel)

initSocket

protected void initSocket(ChannelFD fd)

getOpenChannel

private Channel getOpenChannel()

sockerr

static RuntimeException sockerr(Ruby runtime,
 String msg,
 Exception cause)

extractExceptionArg

static boolean extractExceptionArg(ThreadContext context,
 IRubyObject opts)

asNumber

private static int asNumber(ThreadContext context,
 IRubyObject val)

stringAsNumber

private static int stringAsNumber(ThreadContext context,
 IRubyObject val)

asBoolean

protected boolean asBoolean(ThreadContext context,
 IRubyObject val)

addrFor

protected IRubyObject addrFor(ThreadContext context,
 InetSocketAddress addr,
 boolean reverse)

bindContextMessage

protected static String bindContextMessage(IRubyObject host,
 int port)

recv

@Deprecated
public IRubyObject recv(IRubyObject[] args)

Deprecated.

getsockopt

@Deprecated
public IRubyObject getsockopt(IRubyObject lev,
 IRubyObject optname)

Deprecated.

setsockopt

@Deprecated
public IRubyObject setsockopt(IRubyObject lev,
 IRubyObject optname,
 IRubyObject val)

Deprecated.

getsockname

@Deprecated
public IRubyObject getsockname()

Deprecated.

getpeername

@Deprecated
public IRubyObject getpeername()

Deprecated.

do_not_reverse_lookup

@Deprecated
public static IRubyObject do_not_reverse_lookup(IRubyObject recv)

Deprecated.

set_do_not_reverse_lookup

@Deprecated
public static IRubyObject set_do_not_reverse_lookup(IRubyObject recv,
 IRubyObject flag)

Deprecated.