Module org.jruby.base

Package org.jruby.ext.socket

Class RubySocket

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.RubyIO

org.jruby.ext.socket.RubyBasicSocket

org.jruby.ext.socket.RubySocket

All Implemented Interfaces:

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

Direct Known Subclasses:

RubyServerSocket

public class RubySocket
extends RubyBasicSocket

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.jruby.ext.socket.RubyBasicSocket

RubyBasicSocket.LibC, RubyBasicSocket.ReceiveTuple

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

RubyIO.IOEvent, RubyIO.RubyIOTimeoutError, RubyIO.Sysopen, RubyIO.TimeoutError

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
protected jnr.constants.platform.AddressFamily	soDomain
protected jnr.netdb.Protocol	soProtocol
protected jnr.constants.platform.ProtocolFamily	soProtocolFamily
protected jnr.constants.platform.Sock	soType

Fields inherited from class org.jruby.ext.socket.RubyBasicSocket

multicastStateManager

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, 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
RubySocket(Ruby runtime, RubyClass type)

Method Summary

Modifier and Type	Method	Description
IRubyObject	accept(ThreadContext context)
IRubyObject	accept_nonblock(ThreadContext context, IRubyObject[] args)
protected IRubyObject	addrFor(ThreadContext context, InetSocketAddress addr, boolean reverse)
IRubyObject	bind(ThreadContext context, IRubyObject arg)
IRubyObject	close(ThreadContext context)	Closes all open resources for the IO.
RubyBoolean	closed_p(ThreadContext context)
IRubyObject	connect(ThreadContext context, IRubyObject arg)
IRubyObject	connect_nonblock(ThreadContext context, IRubyObject arg)
IRubyObject	connect_nonblock(ThreadContext context, IRubyObject arg, IRubyObject opts)
protected void	doBind(ThreadContext context, SocketAddress iaddr)
protected IRubyObject	doConnect(ThreadContext context, SocketAddress addr, boolean ex)
static IRubyObject	for_fd(ThreadContext context, IRubyObject socketClass, IRubyObject _fd)
static IRubyObject	getaddrinfo(ThreadContext context, IRubyObject recv, IRubyObject[] args)
static IRubyObject	gethostbyaddr(ThreadContext context, IRubyObject recv, IRubyObject[] args)
static IRubyObject	gethostbyname(ThreadContext context, IRubyObject recv, IRubyObject hostname)
static IRubyObject	gethostname(ThreadContext context, IRubyObject recv)
static IRubyObject	getifaddrs(ThreadContext context, IRubyObject recv)
static IRubyObject	getnameinfo(ThreadContext context, IRubyObject recv, IRubyObject[] args)
static IRubyObject	getservbyname(ThreadContext context, IRubyObject recv, IRubyObject[] args)
protected SocketAddress	getSocketAddress()
protected ChannelFD	initChannelFD(Ruby runtime)
protected void	initFromServer(Ruby runtime, RubySocket serverSocket, SocketChannel socketChannel)
IRubyObject	initialize(ThreadContext context, IRubyObject domain, IRubyObject type)
IRubyObject	initialize(ThreadContext context, IRubyObject domain, IRubyObject type, IRubyObject protocol)
static IRubyObject	ip_address_list(ThreadContext context, IRubyObject self)
IRubyObject	listen(ThreadContext context, IRubyObject backlog)
static IRubyObject	pack_sockaddr_in(ThreadContext context, IRubyObject recv, IRubyObject port, IRubyObject host)
static IRubyObject	pack_sockaddr_un(ThreadContext context, IRubyObject recv, IRubyObject filename)
IRubyObject	recvfrom(ThreadContext context, IRubyObject _length)
IRubyObject	recvfrom(ThreadContext context, IRubyObject _length, IRubyObject _flags)	Overrides IPSocket#recvfrom
IRubyObject	recvfrom_nonblock(ThreadContext context, IRubyObject[] args)
static RuntimeException	sockerr(Ruby runtime, String msg)	Deprecated.
static IRubyObject	socketpair(ThreadContext context, IRubyObject recv, IRubyObject domain, IRubyObject type)
static IRubyObject	socketpair(ThreadContext context, IRubyObject recv, IRubyObject domain, IRubyObject type, IRubyObject protocol)
static IRubyObject	tcp_fast_fallback(ThreadContext context, IRubyObject self)
static IRubyObject	tcp_fast_fallback_set(ThreadContext context, IRubyObject self, IRubyObject value)
static IRubyObject	unpack_sockaddr_in(ThreadContext context, IRubyObject recv, IRubyObject addr)
static IRubyObject	unpack_sockaddr_un(ThreadContext context, IRubyObject recv, IRubyObject addr)

Methods inherited from class org.jruby.ext.socket.RubyBasicSocket

asBoolean, bindContextMessage, bindContextMessage, close_read, close_write, do_not_reverse_lookup, do_not_reverse_lookup, do_not_reverse_lookup, doNotReverseLookup, doRead, doReadNonblock, getInetRemoteSocket, getInetRemoteSocket, getInetSocketAddress, getpeereid, getpeername, getpeername, getRemoteSocket, getRemoteSocket, getsockname, getsockname, getSocknameCommon, getsockopt, getsockopt, getUnixRemoteSocket, getUnixRemoteSocket, getUnixSocketAddress, initSocket, local_address, newChannelFD, read_nonblock, read_nonblock, read_nonblock, read_nonblock, recv, recv, recv, recv_nonblock, recvmsg, recvmsg_nonblock, remote_address, send, send, sendmsg, sendmsg_nonblock, set_do_not_reverse_lookup, set_do_not_reverse_lookup, set_do_not_reverse_lookup, setsockopt, setsockopt, setsockopt, shutdown

Methods inherited from class org.jruby.RubyIO

addBlockingThread, advise, autoclose, autoclose_set, binmode, binmode, binread, binwrite, bytes, chars, checkExecEnv, checkExecOptions, checkLength, checkPopenOptions, checkSpawnOptions, cloexecOpen, close, close_on_exec_p, close_on_exec_set, codepoints, convertToIO, copy_stream, copy_stream, copy_stream, createIOClass, doRead, doReadNonblock, doReadNonblock, doReadNonblock, doReadNonblock, doWriteNonblock, each, each, each, each, each, each_byte, each_byteInternal, each_char, 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, getChannel, getEcflags, getEcopts, getEnc, getEnc2, getInputEncoding, getInStream, getIOModes, getIOModesIntFromString, getline, getline, getline, getline, getline, getline, getNativeClassIndex, getOpenFile, getOpenFileChecked, getOpenFileInitialized, getOutStream, getPath, 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, MakeOpenFile, newInstance, newIO, newIOOptions, newIOOptions, newIOOptions, newIOOptions, newIOOptions, newModeFlags, newModeFlags, newModeFlags, obliterateProcess, op_append, op_binmode, open, parseIOOptions, path, pid, pipe, pipe, pipe, pipe, pipe, pipe, popen, popen3, popen4, popenSpecial, pos, pos_set, pread, pread, prepStdio, prepStdio, print, print, print, print, print, print, print0, print1, print2, print3, printf, printf, putc, putc, puts, puts, puts, puts, puts, puts, puts0, puts1, puts2, puts3, pwrite, rbIoClose, read, read, read, read, read, read, read, read, readbyte, readchar, readchar, readline, readline, readline, readline, readline, readlines, readlines, readlines, readlines, readlines, readlines, readpartial, readpartial, readpartial, removeBlockingThread, reopen, reopenIO, rewind, seek, seek, seek, select, select_static, set_encoding, set_encoding, set_encoding, set_encoding_by_bom, setAscii8bitBinmode, setAutoclose, setBlocking, setBOM, setEcflags, setEcopts, setEnc, setEnc2, setEncoding, setPath, setSync, stat, sync, sync_set, sync_set, sysopen, sysopen, sysopen, sysread, sysread, sysread, sysseek, syswrite, to_io, toJava, toString, tryConvert, tty_p, ungetbyte, ungetc, updateIOOptionsFromOptions, wait, wait, wait_readable, wait_readable, wait_writable, wait_writable, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write_nonblock, write_nonblock, write_nonblock, write2, write3, writeStatic, writev, writev, writev, writev, writev

Methods inherited from class org.jruby.RubyObject

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

Methods inherited from class org.jruby.RubyBasicObject

__id__, addFinalizer, addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callSuper, checkArrayType, checkCallMethod, checkCallMethod, checkFrozen, checkStringType, cloneSetup, compareTo, convertToArray, convertToFloat, convertToHash, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, copySpecialInstanceVariables, dataGetStruct, dataGetStructChecked, dataWrapStruct, decode, display, dup, dupFinalizer, dupSetup, ensureInstanceVariablesSettable, eql, eql_p, eql_p, equal_p, evalUnder, extend, fastGetInstanceVariable, fastGetInternalVariable, fastHasInstanceVariable, fastHasInternalVariable, fastSetInstanceVariable, fastSetInternalVariable, finishBasicObjectClass, forEachInstanceVariable, forEachInstanceVariableName, freeze, frozen_p, getCurrentContext, getFFIHandle, getFlag, getInstanceEvalClass, getInstanceEvalClass, getInstanceVariable, getInstanceVariableList, getInstanceVariableNameList, getInstanceVariables, getInternalVariable, getInternalVariables, getJavaClass, getMarshalVariableList, getMetaClass, getMetaClass, getNativeHandle, getNativeTypeIndex, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getSingletonClassCloneAndAttach, getSingletonClassCloneAndAttach, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hash, hash, hashyInspect, hasInstanceVariable, hasInstanceVariables, hasInternalVariable, hasVariables, id, infectBy, initialize, initialize_copy, inspect, inspectHashCode, instance_eval, instance_eval, instance_eval, instance_eval, instance_eval, instance_exec, instance_of_p, instance_variable_defined_p, instance_variable_get, instance_variable_set, instance_variables, isBuiltin, isClass, isFalse, isFrozen, isImmediate, isModule, isNil, isSpecialConst, isSpecialObject, isTaint, isTrue, isUntrusted, kind_of_p, makeMetaClass, makeMetaClass, makeMetaClassBootstrap, method, method, method, method_missing, methods, methods, nil_p, nonFixnumHashCode, nonFixnumHashCode, OBJ_INIT_COPY, objInitCopy, op_cmp, op_equal, op_match, op_not, op_not_equal, op_not_match, private_methods, protected_methods, public_methods, rbClone, rbClone, rbInspect, remove_instance_variable, removeFinalizers, removeInstanceVariable, removeInternalVariable, respond_to_p, respond_to_p, respondsTo, respondsToMissing, respondsToMissing, send, send, send, send, send, setFFIHandle, setFlag, setFrozen, setInstanceVariable, setInternalVariable, setMetaClass, setNativeHandle, setTaint, setUntrusted, setVariable, singleton_method, singleton_method, singleton_method_added, singleton_method_removed, singleton_method_undefined, singleton_methods, singletonClass, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, taint, tainted_p, testFrozen, testFrozen, to_a, to_a, to_s, to_s, trust, type, 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

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

checkStringType19, dup, marshalLiveVariables

Field Details

soDomain

protected jnr.constants.platform.AddressFamily soDomain

soProtocolFamily

protected jnr.constants.platform.ProtocolFamily soProtocolFamily

soType

protected jnr.constants.platform.Sock soType

soProtocol

protected jnr.netdb.Protocol soProtocol

Constructor Details

RubySocket

public RubySocket(Ruby runtime,
 RubyClass type)

Method Details

for_fd

public static IRubyObject for_fd(ThreadContext context,
 IRubyObject socketClass,
 IRubyObject _fd)

initialize

public IRubyObject initialize(ThreadContext context,
 IRubyObject domain,
 IRubyObject type)

initialize

public IRubyObject initialize(ThreadContext context,
 IRubyObject domain,
 IRubyObject type,
 IRubyObject protocol)

connect_nonblock

public IRubyObject connect_nonblock(ThreadContext context,
 IRubyObject arg)

connect_nonblock

public IRubyObject connect_nonblock(ThreadContext context,
 IRubyObject arg,
 IRubyObject opts)

connect

public IRubyObject connect(ThreadContext context,
 IRubyObject arg)

bind

public IRubyObject bind(ThreadContext context,
 IRubyObject arg)

recvfrom

public IRubyObject recvfrom(ThreadContext context,
 IRubyObject _length)

recvfrom

public IRubyObject recvfrom(ThreadContext context,
 IRubyObject _length,
 IRubyObject _flags)

Overrides IPSocket#recvfrom

recvfrom_nonblock

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

listen

public IRubyObject listen(ThreadContext context,
 IRubyObject backlog)

accept

public IRubyObject accept(ThreadContext context)

accept_nonblock

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

gethostname

public static IRubyObject gethostname(ThreadContext context,
 IRubyObject recv)

getifaddrs

public static IRubyObject getifaddrs(ThreadContext context,
 IRubyObject recv)

gethostbyaddr

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

getservbyname

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

pack_sockaddr_in

public static IRubyObject pack_sockaddr_in(ThreadContext context,
 IRubyObject recv,
 IRubyObject port,
 IRubyObject host)

unpack_sockaddr_in

public static IRubyObject unpack_sockaddr_in(ThreadContext context,
 IRubyObject recv,
 IRubyObject addr)

pack_sockaddr_un

public static IRubyObject pack_sockaddr_un(ThreadContext context,
 IRubyObject recv,
 IRubyObject filename)

unpack_sockaddr_un

public static IRubyObject unpack_sockaddr_un(ThreadContext context,
 IRubyObject recv,
 IRubyObject addr)

gethostbyname

public static IRubyObject gethostbyname(ThreadContext context,
 IRubyObject recv,
 IRubyObject hostname)

getaddrinfo

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

getnameinfo

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

ip_address_list

public static IRubyObject ip_address_list(ThreadContext context,
 IRubyObject self)

socketpair

public static IRubyObject socketpair(ThreadContext context,
 IRubyObject recv,
 IRubyObject domain,
 IRubyObject type,
 IRubyObject protocol)

socketpair

public static IRubyObject socketpair(ThreadContext context,
 IRubyObject recv,
 IRubyObject domain,
 IRubyObject type)

initFromServer

protected void initFromServer(Ruby runtime,
 RubySocket serverSocket,
 SocketChannel socketChannel)

initChannelFD

protected ChannelFD initChannelFD(Ruby runtime)

doConnect

protected IRubyObject doConnect(ThreadContext context,
 SocketAddress addr,
 boolean ex)

doBind

protected void doBind(ThreadContext context,
 SocketAddress iaddr)

addrFor

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

Overrides:

addrFor in class RubyBasicSocket

close

public IRubyObject close(ThreadContext context)

Description copied from class: RubyIO

Closes all open resources for the IO. It also removes it from our magical all open file descriptor pool.

Overrides:

close in class RubyIO

Returns:

The IO. Returns nil if the IO was already closed. MRI: rb_io_close_m

tcp_fast_fallback

public static IRubyObject tcp_fast_fallback(ThreadContext context,
 IRubyObject self)

tcp_fast_fallback_set

public static IRubyObject tcp_fast_fallback_set(ThreadContext context,
 IRubyObject self,
 IRubyObject value)

closed_p

public RubyBoolean closed_p(ThreadContext context)

Overrides:

closed_p in class RubyIO

getSocketAddress

protected SocketAddress getSocketAddress()

Overrides:

getSocketAddress in class RubyBasicSocket

sockerr

@Deprecated(since="1.7.0")
public static RuntimeException sockerr(Ruby runtime,
 String msg)

Deprecated.