Class: EventMachine::Connection

Inherits:
Object
  • Object
show all
Defined in:
lib/eventmachine.rb,
ext/rubymain.cpp

Overview

EventMachine::Connection is a class that is instantiated by EventMachine’s processing loop whenever a new connection is created. (New connections can be either initiated locally to a remote server or accepted locally from a remote client.) When a Connection object is instantiated, it mixes in the functionality contained in the user-defined module specified in calls to EventMachine#connect or EventMachine#start_server. User-defined handler modules may redefine any or all of the standard methods defined here, as well as add arbitrary additional code that will also be mixed in.

EventMachine manages one object inherited from EventMachine::Connection (and containing the mixed-in user code) for every network connection that is active at any given time. The event loop will automatically call methods on EventMachine::Connection objects whenever specific events occur on the corresponding connections, as described below.

This class is never instantiated by user code, and does not publish an initialize method. The instance methods of EventMachine::Connection which may be called by the event loop are: post_init, receive_data, and unbind. All of the other instance methods defined here are called only by user code.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(sig) ⇒ Connection

:nodoc:



1030
1031
1032
1033
 
# File 'lib/eventmachine.rb', line 1030

def initialize sig #:nodoc:
	@signature = sig
	post_init
end

Instance Attribute Details

#signature ⇒ Object

EXPERIMENTAL. Added the reconnect methods, which may go away.



1028
1029
1030
 
# File 'lib/eventmachine.rb', line 1028

def signature
  @signature
end

Instance Method Details

#close_connection(after_writing = false) ⇒ Object

EventMachine::Connection#close_connection is called only by user code, and never by the event loop. You may call this method against a connection object in any callback handler, whether or not the callback was made against the connection you want to close. close_connection schedules the connection to be closed at the next available opportunity within the event loop. You may not assume that the connection is closed when close_connection returns. In particular, the framework will callback the unbind method for the particular connection at a point shortly after you call close_connection. You may assume that the unbind callback will take place sometime after your call to close_connection completes. In other words, the unbind callback will not re-enter your code “inside” of your call to close_connection. However, it’s not guaranteed that a future version of EventMachine will not change this behavior.

close_connection will silently discard any outbound data which you have sent to the connection using EventMachine::Connection#send_data but which has not yet been sent across the network. If you want to avoid this behavior, use EventMachine::Connection#close_connection_after_writing.



1106
1107
1108
 
# File 'lib/eventmachine.rb', line 1106

def close_connection after_writing = false
	EventMachine::close_connection @signature, after_writing
end

#close_connection_after_writing ⇒ Object

EventMachine::Connection#close_connection_after_writing is a variant of close_connection. All of the descriptive comments given for close_connection also apply to close_connection_after_writing, with one exception: If the connection has outbound data sent using send_dat but which has not yet been sent across the network, close_connection_after_writing will schedule the connection to be closed after all of the outbound data has been safely written to the remote peer.

Depending on the amount of outgoing data and the speed of the network, considerable time may elapse between your call to close_connection_after_writing and the actual closing of the socket (at which time the unbind callback will be called by the event loop). During this time, you may not call send_data to transmit additional data (that is, the connection is closed for further writes). In very rare cases, you may experience a receive_data callback after your call to close_connection_after_writing, depending on whether incoming data was in the process of being received on the connection at the moment when you called close_connection_after_writing. Your protocol handler must be prepared to properly deal with such data (probably by ignoring it).



1127
1128
1129
 
# File 'lib/eventmachine.rb', line 1127

def close_connection_after_writing
	close_connection true
end

#comm_inactivity_timeout ⇒ Object

comm_inactivity_timeout returns the current value (in seconds) of the inactivity-timeout property of network-connection and datagram-socket objects. A nonzero value indicates that the connection or socket will automatically be closed if no read or write activity takes place for at least that number of seconds. A zero value (the default) specifies that no automatic timeout will take place.



1220
1221
1222
 
# File 'lib/eventmachine.rb', line 1220

def comm_inactivity_timeout
	EventMachine::get_comm_inactivity_timeout @signature
end

#comm_inactivity_timeout=(value) ⇒ Object

Alias for #set_comm_inactivity_timeout.



1225
1226
1227
 
# File 'lib/eventmachine.rb', line 1225

def comm_inactivity_timeout= value
	self.send :set_comm_inactivity_timeout, value
end

#connection_completed ⇒ Object

#connection_completed is called by the event loop when a remote TCP connection attempt completes successfully. You can expect to get this notification after calls to EventMachine#connect. Remember that EventMachine makes remote connections asynchronously, just as with any other kind of network event. #connection_completed is intended primarily to assist with network diagnostics. For normal protocol handling, use #post_init to perform initial work on a new connection (such as send an initial set of data). #post_init will always be called. #connection_completed will only be called in case of a successful completion. A connection-attempt which fails will receive a call to #unbind after the failure.



1160
1161
 
# File 'lib/eventmachine.rb', line 1160

def connection_completed
end

#get_peername ⇒ Object

#get_peername is used with stream-connections to obtain the identity of the remotely-connected peer. If a peername is available, this method returns a sockaddr structure. The method returns nil if no peername is available. You can use Socket#unpack_sockaddr_in and its variants to obtain the values contained in the peername structure returned from #get_peername.



1202
1203
1204
 
# File 'lib/eventmachine.rb', line 1202

def get_peername
	EventMachine::get_peername @signature
end

#get_pid ⇒ Object

Returns the PID (kernel process identifier) of a subprocess associated with this Connection object. For use with EventMachine#popen and similar methods. Returns nil when there is no meaningful subprocess. –



1211
1212
1213
 
# File 'lib/eventmachine.rb', line 1211

def get_pid
	EventMachine::get_subprocess_pid @signature
end

#post_init ⇒ Object

EventMachine::Connection#post_init is called by the event loop immediately after the network connection has been established, and before resumption of the network loop. This method is generally not called by user code, but is called automatically by the event loop. The base-class implementation is a no-op. This is a very good place to initialize instance variables that will be used throughout the lifetime of the network connection.



1043
1044
 
# File 'lib/eventmachine.rb', line 1043

def post_init
end

#receive_data(data) ⇒ Object

EventMachine::Connection#receive_data is called by the event loop whenever data has been received by the network connection. It is never called by user code. receive_data is called with a single parameter, a String containing the network protocol data, which may of course be binary. You will generally redefine this method to perform your own processing of the incoming data.

Here’s a key point which is essential to understanding the event-driven programming model: EventMachine knows absolutely nothing about the protocol which your code implements. You must not make any assumptions about the size of the incoming data packets, or about their alignment on any particular intra-message or PDU boundaries (such as line breaks). receive_data can and will send you arbitrary chunks of data, with the only guarantee being that the data is presented to your code in the order it was collected from the network. Don’t even assume that the chunks of data will correspond to network packets, as EventMachine can and will coalesce several incoming packets into one, to improve performance. The implication for your code is that you generally will need to implement some kind of a state machine in your redefined implementation of receive_data. For a better understanding of this, read through the examples of specific protocol handlers given elsewhere in this package. (STUB, WE MUST ADD THESE!)

The base-class implementation of receive_data (which will be invoked if you don’t redefine it) simply prints the size of each incoming data packet to stdout.



1072
1073
1074
 
# File 'lib/eventmachine.rb', line 1072

def receive_data data
	puts "............>>>#{data.length}"
end

#reconnect(server, port) ⇒ Object

– EXPERIMENTAL. DO NOT RELY ON THIS METHOD TO REMAIN SUPPORTED. (03Nov06)



1242
1243
1244
 
# File 'lib/eventmachine.rb', line 1242

def reconnect server, port
	EventMachine::reconnect server, port, self
end

#send_data(data) ⇒ Object

EventMachine::Connection#send_data is only called by user code, never by the event loop. You call this method to send data to the remote end of the network connection. send_data is called with a single String argument, which may of course contain binary data. You can call send_data any number of times. send_data is an instance method of an object derived from EventMachine::Connection and containing your mixed-in handler code), so if you call it without qualification within a callback function, the data will be sent to the same network connection that generated the callback. Calling self.send_data is exactly equivalent.

You can also call send_data to write to a connection other than the one whose callback you are calling send_data from. This is done by recording the value of the connection in any callback function (the value self), in any variable visible to other callback invocations on the same or different connection objects. (Need an example to make that clear.)



1146
1147
1148
 
# File 'lib/eventmachine.rb', line 1146

def send_data data
	EventMachine::send_data @signature, data, data.length
end

#send_datagram(data, recipient_address, recipient_port) ⇒ Object

send_datagram is for sending UDP messages. This method may be called from any Connection object that refers to an open datagram socket (see EventMachine#open_datagram_socket). The method sends a UDP (datagram) packet containing the data you specify, to a remote peer specified by the IP address and port that you give as parameters to the method. Observe that you may send a zero-length packet (empty string). However, you may not send an arbitrarily-large data packet because your operating system will enforce a platform-specific limit on the size of the outbound packet. (Your kernel will respond in a platform-specific way if you send an overlarge packet: some will send a truncated packet, some will complain, and some will silently drop your request). On LANs, it’s usually OK to send datagrams up to about 4000 bytes in length, but to be really safe, send messages smaller than the Ethernet-packet size (typically about 1400 bytes). Some very restrictive WANs will either drop or truncate packets larger than about 500 bytes.



1191
1192
1193
1194
 
# File 'lib/eventmachine.rb', line 1191

def send_datagram data, recipient_address, recipient_port
	data = data.to_s
	EventMachine::send_datagram @signature, data, data.length, recipient_address, recipient_port
end

#send_file_data(filename) ⇒ Object

Like EventMachine::Connection#send_data, this sends data to the remote end of the network connection. EventMachine::Connection@send_file_data takes a filename as an argument, though, and sends the contents of the file, in one chunk. Contributed by Kirk Haines.



1252
1253
1254
 
# File 'lib/eventmachine.rb', line 1252

def send_file_data filename
	EventMachine::send_file_data @signature, filename
end

#set_comm_inactivity_timeout(value) ⇒ Object

comm_inactivity_timeout= allows you to set the inactivity-timeout property for a network connection or datagram socket. Specify a non-negative numeric value in seconds. If the value is greater than zero, the connection or socket will automatically be closed if no read or write activity takes place for at least that number of seconds. Specify a value of zero to indicate that no automatic timeout should take place. Zero is the default value.



1235
1236
1237
 
# File 'lib/eventmachine.rb', line 1235

def set_comm_inactivity_timeout value
	EventMachine::set_comm_inactivity_timeout @signature, value
end

#start_tls ⇒ Object

Call #start_tls at any point to initiate TLS encryption on connected streams. The method is smart enough to know whether it should perform a server-side or a client-side handshake. An appropriate place to call #start_tls is in your redefined #post_init method.



1168
1169
1170
 
# File 'lib/eventmachine.rb', line 1168

def start_tls
	EventMachine::start_tls @signature
end

#stream_file_data(filename, args = {}) ⇒ Object

Open a file on the filesystem and send it to the remote peer. This returns an object of type EventMachine::Deferrable. The object’s callbacks will be executed on the reactor main thread when the file has been completely scheduled for transmission to the remote peer. Its errbacks will be called in case of an error (such as file-not-found). #stream_file_data employs various strategems to achieve the fastest possible performance, balanced against minimum consumption of memory.

You can control the behavior of #stream_file_data with the optional arguments parameter. Currently-supported arguments are: :http_chunks, a boolean flag which defaults false. If true, this flag streams the file data in a format compatible with the HTTP chunked-transfer encoding.

Warning: this feature has an implicit dependency on an outboard extension, evma_fastfilereader. You must install this extension in order to use #stream_file_data with files larger than a certain size (currently 8192 bytes).



1272
1273
1274
 
# File 'lib/eventmachine.rb', line 1272

def stream_file_data filename, args={}
	EventMachine::FileStreamer.new( self, filename, args )
end

#unbind ⇒ Object

EventMachine::Connection#unbind is called by the framework whenever a connection (either a server or client connection) is closed. The close can occur because your code intentionally closes it (see close_connection and close_connection_after_writing), because the remote peer closed the connection, or because of a network error. You may not assume that the network connection is still open and able to send or receive data when the callback to unbind is made. This is intended only to give you a chance to clean up associations your code may have made to the connection object while it was open.



1085
1086
 
# File 'lib/eventmachine.rb', line 1085

def unbind
end