passenger 3.0.7 → 3.0.8
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of passenger might be problematic. Click here for more details.
- data/NEWS +27 -0
- data/README +1 -1
- data/bin/passenger-install-nginx-module +3 -1
- data/build/config.rb +2 -1
- data/build/cxx_tests.rb +7 -3
- data/build/documentation.rb +5 -40
- data/build/nginx.rb +0 -1
- data/build/packaging.rb +0 -6
- data/build/rake_extensions.rb +5 -0
- data/doc/Architectural overview.html +344 -77
- data/doc/Security of user switching support.html +338 -71
- data/doc/Users guide Apache with comments.html +4830 -0
- data/doc/Users guide Apache.html +695 -428
- data/doc/Users guide Apache.idmap.txt +80 -0
- data/doc/Users guide Apache.txt +5 -5
- data/doc/Users guide Nginx.html +591 -313
- data/doc/Users guide Nginx.txt +9 -3
- data/doc/Users guide Standalone.html +344 -77
- data/ext/boost/src/pthread/thread.cpp +1 -1
- data/ext/common/AccountsDatabase.h +1 -1
- data/ext/common/Constants.h +2 -2
- data/ext/common/Logging.h +2 -1
- data/ext/common/LoggingAgent/FilterSupport.h +107 -3
- data/ext/common/Session.h +1 -1
- data/ext/common/Utils.cpp +2 -0
- data/ext/common/Utils/Dechunker.h +232 -0
- data/ext/common/Utils/HttpHeaderBufferer.h +165 -0
- data/ext/common/Utils/StrIntUtils.cpp +51 -15
- data/ext/common/Utils/StrIntUtils.h +3 -0
- data/ext/common/Utils/StreamBoyerMooreHorspool.h +506 -0
- data/ext/nginx/Configuration.c +36 -282
- data/ext/nginx/ContentHandler.c +17 -0
- data/ext/nginx/HelperAgent.cpp +397 -39
- data/ext/oxt/tracable_exception.cpp +3 -1
- data/ext/ruby/extconf.rb +1 -0
- data/ext/ruby/passenger_native_support.c +3 -0
- data/helper-scripts/prespawn +113 -31
- data/lib/phusion_passenger.rb +2 -2
- data/lib/phusion_passenger/standalone/runtime_installer.rb +3 -2
- data/lib/phusion_passenger/standalone/start_command.rb +12 -12
- data/test/cxx/DechunkerTest.cpp +216 -0
- data/test/cxx/FilterSupportTest.cpp +31 -4
- data/test/cxx/HttpHeaderBuffererTest.cpp +203 -0
- data/test/cxx/UtilsTest.cpp +46 -3
- data/test/integration_tests/hello_world_rack_spec.rb +7 -0
- data/test/stub/rack/config.ru +6 -1
- data/test/stub/rails_apps/1.2/empty/public/dispatch.cgi +1 -1
- data/test/stub/rails_apps/1.2/empty/public/dispatch.fcgi +1 -1
- data/test/stub/rails_apps/1.2/empty/public/dispatch.rb +1 -1
- data/test/stub/rails_apps/2.0/empty/public/dispatch.cgi +1 -1
- data/test/stub/rails_apps/2.0/empty/public/dispatch.fcgi +1 -1
- data/test/stub/rails_apps/2.0/empty/public/dispatch.rb +1 -1
- data/test/stub/rails_apps/2.2/empty/public/dispatch.cgi +1 -1
- data/test/stub/rails_apps/2.2/empty/public/dispatch.fcgi +1 -1
- data/test/stub/rails_apps/2.2/empty/public/dispatch.rb +1 -1
- metadata +20 -403
- data/doc/Doxyfile +0 -241
- data/doc/cxxapi/AbstractSpawnManager_8h_source.html +0 -141
- data/doc/cxxapi/Account_8h_source.html +0 -206
- data/doc/cxxapi/AccountsDatabase_8h_source.html +0 -161
- data/doc/cxxapi/AgentBase_8h_source.html +0 -70
- data/doc/cxxapi/AgentsStarter_8h_source.html +0 -112
- data/doc/cxxapi/BCrypt_8h_source.html +0 -104
- data/doc/cxxapi/Blowfish_8h_source.html +0 -134
- data/doc/cxxapi/Bucket_8h_source.html +0 -118
- data/doc/cxxapi/Constants_8h_source.html +0 -79
- data/doc/cxxapi/ContentHandler_8h_source.html +0 -95
- data/doc/cxxapi/DirectoryMapper_8h_source.html +0 -311
- data/doc/cxxapi/EventedClient_8h_source.html +0 -733
- data/doc/cxxapi/EventedMessageServer_8h_source.html +0 -358
- data/doc/cxxapi/EventedServer_8h_source.html +0 -326
- data/doc/cxxapi/Exceptions_8h_source.html +0 -393
- data/doc/cxxapi/FileDescriptor_8h_source.html +0 -324
- data/doc/cxxapi/Hooks_8h_source.html +0 -76
- data/doc/cxxapi/HttpStatusExtractor_8h_source.html +0 -382
- data/doc/cxxapi/IniFile_8h_source.html +0 -527
- data/doc/cxxapi/Logging_8h_source.html +0 -796
- data/doc/cxxapi/MessageChannel_8h_source.html +0 -776
- data/doc/cxxapi/MessageClient_8h_source.html +0 -328
- data/doc/cxxapi/MessageReadersWriters_8h_source.html +0 -539
- data/doc/cxxapi/MessageServer_8h_source.html +0 -612
- data/doc/cxxapi/PoolOptions_8h_source.html +0 -549
- data/doc/cxxapi/Process_8h_source.html +0 -286
- data/doc/cxxapi/RandomGenerator_8h_source.html +0 -191
- data/doc/cxxapi/ResourceLocator_8h_source.html +0 -166
- data/doc/cxxapi/SafeLibev_8h_source.html +0 -180
- data/doc/cxxapi/ScgiRequestParser_8h_source.html +0 -406
- data/doc/cxxapi/ServerInstanceDir_8h_source.html +0 -378
- data/doc/cxxapi/Session_8h_source.html +0 -501
- data/doc/cxxapi/SpawnManager_8h_source.html +0 -647
- data/doc/cxxapi/StaticContentHandler_8h_source.html +0 -69
- data/doc/cxxapi/StaticString_8h_source.html +0 -329
- data/doc/cxxapi/StringListCreator_8h_source.html +0 -114
- data/doc/cxxapi/Utils_8h_source.html +0 -469
- data/doc/cxxapi/annotated.html +0 -87
- data/doc/cxxapi/apache2_2Configuration_8h_source.html +0 -82
- data/doc/cxxapi/classAgentWatcher-members.html +0 -54
- data/doc/cxxapi/classAgentWatcher.html +0 -419
- data/doc/cxxapi/classClient-members.html +0 -38
- data/doc/cxxapi/classClient.html +0 -123
- data/doc/cxxapi/classHooks-members.html +0 -40
- data/doc/cxxapi/classHooks.html +0 -153
- data/doc/cxxapi/classPassenger_1_1AbstractSpawnManager-members.html +0 -40
- data/doc/cxxapi/classPassenger_1_1AbstractSpawnManager.html +0 -187
- data/doc/cxxapi/classPassenger_1_1AbstractSpawnManager__inherit__graph.map +0 -3
- data/doc/cxxapi/classPassenger_1_1AbstractSpawnManager__inherit__graph.md5 +0 -1
- data/doc/cxxapi/classPassenger_1_1AbstractSpawnManager__inherit__graph.png +0 -0
- data/doc/cxxapi/classPassenger_1_1ArgumentException-members.html +0 -36
- data/doc/cxxapi/classPassenger_1_1ArgumentException.html +0 -56
- data/doc/cxxapi/classPassenger_1_1ArrayMessage-members.html +0 -37
- data/doc/cxxapi/classPassenger_1_1ArrayMessage.html +0 -113
- data/doc/cxxapi/classPassenger_1_1BufferedUpload-members.html +0 -38
- data/doc/cxxapi/classPassenger_1_1BufferedUpload.html +0 -112
- data/doc/cxxapi/classPassenger_1_1BusyException-members.html +0 -36
- data/doc/cxxapi/classPassenger_1_1BusyException.html +0 -54
- data/doc/cxxapi/classPassenger_1_1ConfigurationException-members.html +0 -36
- data/doc/cxxapi/classPassenger_1_1ConfigurationException.html +0 -51
- data/doc/cxxapi/classPassenger_1_1DirectoryMapper-members.html +0 -41
- data/doc/cxxapi/classPassenger_1_1DirectoryMapper.html +0 -223
- data/doc/cxxapi/classPassenger_1_1EOFException-members.html +0 -36
- data/doc/cxxapi/classPassenger_1_1EOFException.html +0 -61
- data/doc/cxxapi/classPassenger_1_1EOFException__inherit__graph.map +0 -3
- data/doc/cxxapi/classPassenger_1_1EOFException__inherit__graph.md5 +0 -1
- data/doc/cxxapi/classPassenger_1_1EOFException__inherit__graph.png +0 -0
- data/doc/cxxapi/classPassenger_1_1EventFd-members.html +0 -36
- data/doc/cxxapi/classPassenger_1_1EventFd.html +0 -52
- data/doc/cxxapi/classPassenger_1_1EventedClient-members.html +0 -59
- data/doc/cxxapi/classPassenger_1_1EventedClient.html +0 -531
- data/doc/cxxapi/classPassenger_1_1EventedMessageServer-members.html +0 -37
- data/doc/cxxapi/classPassenger_1_1EventedMessageServer.html +0 -59
- data/doc/cxxapi/classPassenger_1_1EventedMessageServer__inherit__graph.map +0 -3
- data/doc/cxxapi/classPassenger_1_1EventedMessageServer__inherit__graph.md5 +0 -1
- data/doc/cxxapi/classPassenger_1_1EventedMessageServer__inherit__graph.png +0 -0
- data/doc/cxxapi/classPassenger_1_1EventedServer-members.html +0 -37
- data/doc/cxxapi/classPassenger_1_1EventedServer.html +0 -93
- data/doc/cxxapi/classPassenger_1_1EventedServer__inherit__graph.map +0 -3
- data/doc/cxxapi/classPassenger_1_1EventedServer__inherit__graph.md5 +0 -1
- data/doc/cxxapi/classPassenger_1_1EventedServer__inherit__graph.png +0 -0
- data/doc/cxxapi/classPassenger_1_1FileDescriptor-members.html +0 -41
- data/doc/cxxapi/classPassenger_1_1FileDescriptor.html +0 -178
- data/doc/cxxapi/classPassenger_1_1FileDescriptorPair-members.html +0 -36
- data/doc/cxxapi/classPassenger_1_1FileDescriptorPair.html +0 -52
- data/doc/cxxapi/classPassenger_1_1FileNotFoundException-members.html +0 -36
- data/doc/cxxapi/classPassenger_1_1FileNotFoundException.html +0 -58
- data/doc/cxxapi/classPassenger_1_1FileNotFoundException__inherit__graph.map +0 -3
- data/doc/cxxapi/classPassenger_1_1FileNotFoundException__inherit__graph.md5 +0 -1
- data/doc/cxxapi/classPassenger_1_1FileNotFoundException__inherit__graph.png +0 -0
- data/doc/cxxapi/classPassenger_1_1FileSystemException-members.html +0 -41
- data/doc/cxxapi/classPassenger_1_1FileSystemException.html +0 -66
- data/doc/cxxapi/classPassenger_1_1FileSystemException__inherit__graph.map +0 -3
- data/doc/cxxapi/classPassenger_1_1FileSystemException__inherit__graph.md5 +0 -1
- data/doc/cxxapi/classPassenger_1_1FileSystemException__inherit__graph.png +0 -0
- data/doc/cxxapi/classPassenger_1_1HttpStatusExtractor-members.html +0 -39
- data/doc/cxxapi/classPassenger_1_1HttpStatusExtractor.html +0 -128
- data/doc/cxxapi/classPassenger_1_1IOException-members.html +0 -36
- data/doc/cxxapi/classPassenger_1_1IOException.html +0 -61
- data/doc/cxxapi/classPassenger_1_1IOException__inherit__graph.map +0 -4
- data/doc/cxxapi/classPassenger_1_1IOException__inherit__graph.md5 +0 -1
- data/doc/cxxapi/classPassenger_1_1IOException__inherit__graph.png +0 -0
- data/doc/cxxapi/classPassenger_1_1MessageChannel-members.html +0 -57
- data/doc/cxxapi/classPassenger_1_1MessageChannel.html +0 -839
- data/doc/cxxapi/classPassenger_1_1MessageServer-members.html +0 -49
- data/doc/cxxapi/classPassenger_1_1MessageServer.html +0 -407
- data/doc/cxxapi/classPassenger_1_1MessageServer_1_1ClientContext-members.html +0 -36
- data/doc/cxxapi/classPassenger_1_1MessageServer_1_1ClientContext.html +0 -58
- data/doc/cxxapi/classPassenger_1_1MessageServer_1_1ClientContext__inherit__graph.map +0 -3
- data/doc/cxxapi/classPassenger_1_1MessageServer_1_1ClientContext__inherit__graph.md5 +0 -1
- data/doc/cxxapi/classPassenger_1_1MessageServer_1_1ClientContext__inherit__graph.png +0 -0
- data/doc/cxxapi/classPassenger_1_1MessageServer_1_1CommonClientContext-members.html +0 -41
- data/doc/cxxapi/classPassenger_1_1MessageServer_1_1CommonClientContext.html +0 -165
- data/doc/cxxapi/classPassenger_1_1MessageServer_1_1CommonClientContext__inherit__graph.map +0 -3
- data/doc/cxxapi/classPassenger_1_1MessageServer_1_1CommonClientContext__inherit__graph.md5 +0 -1
- data/doc/cxxapi/classPassenger_1_1MessageServer_1_1CommonClientContext__inherit__graph.png +0 -0
- data/doc/cxxapi/classPassenger_1_1MessageServer_1_1Handler-members.html +0 -39
- data/doc/cxxapi/classPassenger_1_1MessageServer_1_1Handler.html +0 -173
- data/doc/cxxapi/classPassenger_1_1Process-members.html +0 -44
- data/doc/cxxapi/classPassenger_1_1Process.html +0 -290
- data/doc/cxxapi/classPassenger_1_1RandomGenerator-members.html +0 -37
- data/doc/cxxapi/classPassenger_1_1RandomGenerator.html +0 -79
- data/doc/cxxapi/classPassenger_1_1ResourceLocator-members.html +0 -36
- data/doc/cxxapi/classPassenger_1_1ResourceLocator.html +0 -51
- data/doc/cxxapi/classPassenger_1_1RuntimeException-members.html +0 -36
- data/doc/cxxapi/classPassenger_1_1RuntimeException.html +0 -54
- data/doc/cxxapi/classPassenger_1_1SafeLibev-members.html +0 -36
- data/doc/cxxapi/classPassenger_1_1SafeLibev.html +0 -51
- data/doc/cxxapi/classPassenger_1_1ScalarMessage-members.html +0 -37
- data/doc/cxxapi/classPassenger_1_1ScalarMessage.html +0 -76
- data/doc/cxxapi/classPassenger_1_1ScgiRequestParser-members.html +0 -50
- data/doc/cxxapi/classPassenger_1_1ScgiRequestParser.html +0 -285
- data/doc/cxxapi/classPassenger_1_1SecurityException-members.html +0 -36
- data/doc/cxxapi/classPassenger_1_1SecurityException.html +0 -56
- data/doc/cxxapi/classPassenger_1_1Session-members.html +0 -53
- data/doc/cxxapi/classPassenger_1_1Session.html +0 -556
- data/doc/cxxapi/classPassenger_1_1Session__inherit__graph.map +0 -3
- data/doc/cxxapi/classPassenger_1_1Session__inherit__graph.md5 +0 -1
- data/doc/cxxapi/classPassenger_1_1Session__inherit__graph.png +0 -0
- data/doc/cxxapi/classPassenger_1_1SpawnException-members.html +0 -39
- data/doc/cxxapi/classPassenger_1_1SpawnException.html +0 -101
- data/doc/cxxapi/classPassenger_1_1SpawnManager-members.html +0 -42
- data/doc/cxxapi/classPassenger_1_1SpawnManager.html +0 -292
- data/doc/cxxapi/classPassenger_1_1SpawnManager__inherit__graph.map +0 -3
- data/doc/cxxapi/classPassenger_1_1SpawnManager__inherit__graph.md5 +0 -1
- data/doc/cxxapi/classPassenger_1_1SpawnManager__inherit__graph.png +0 -0
- data/doc/cxxapi/classPassenger_1_1StandardSession-members.html +0 -54
- data/doc/cxxapi/classPassenger_1_1StandardSession.html +0 -394
- data/doc/cxxapi/classPassenger_1_1StandardSession__inherit__graph.map +0 -3
- data/doc/cxxapi/classPassenger_1_1StandardSession__inherit__graph.md5 +0 -1
- data/doc/cxxapi/classPassenger_1_1StandardSession__inherit__graph.png +0 -0
- data/doc/cxxapi/classPassenger_1_1StaticString-members.html +0 -36
- data/doc/cxxapi/classPassenger_1_1StaticString.html +0 -56
- data/doc/cxxapi/classPassenger_1_1SyntaxError-members.html +0 -36
- data/doc/cxxapi/classPassenger_1_1SyntaxError.html +0 -54
- data/doc/cxxapi/classPassenger_1_1SystemException-members.html +0 -40
- data/doc/cxxapi/classPassenger_1_1SystemException.html +0 -155
- data/doc/cxxapi/classPassenger_1_1SystemException__inherit__graph.map +0 -4
- data/doc/cxxapi/classPassenger_1_1SystemException__inherit__graph.md5 +0 -1
- data/doc/cxxapi/classPassenger_1_1SystemException__inherit__graph.png +0 -0
- data/doc/cxxapi/classPassenger_1_1TimeRetrievalException-members.html +0 -40
- data/doc/cxxapi/classPassenger_1_1TimeRetrievalException.html +0 -61
- data/doc/cxxapi/classPassenger_1_1TimeRetrievalException__inherit__graph.map +0 -3
- data/doc/cxxapi/classPassenger_1_1TimeRetrievalException__inherit__graph.md5 +0 -1
- data/doc/cxxapi/classPassenger_1_1TimeRetrievalException__inherit__graph.png +0 -0
- data/doc/cxxapi/classPassenger_1_1TimeoutException-members.html +0 -36
- data/doc/cxxapi/classPassenger_1_1TimeoutException.html +0 -54
- data/doc/cxxapi/classPassenger_1_1Uint16Message-members.html +0 -36
- data/doc/cxxapi/classPassenger_1_1Uint16Message.html +0 -51
- data/doc/cxxapi/classPassenger_1_1Uint32Message-members.html +0 -36
- data/doc/cxxapi/classPassenger_1_1Uint32Message.html +0 -51
- data/doc/cxxapi/classServer-members.html +0 -36
- data/doc/cxxapi/classServer.html +0 -49
- data/doc/cxxapi/classServerInstanceDirToucher-members.html +0 -36
- data/doc/cxxapi/classServerInstanceDirToucher.html +0 -47
- data/doc/cxxapi/classes.html +0 -52
- data/doc/cxxapi/definitions_8h_source.html +0 -36
- data/doc/cxxapi/doxygen.css +0 -532
- data/doc/cxxapi/doxygen.png +0 -0
- data/doc/cxxapi/files.html +0 -76
- data/doc/cxxapi/ftv2blank.png +0 -0
- data/doc/cxxapi/ftv2doc.png +0 -0
- data/doc/cxxapi/ftv2folderclosed.png +0 -0
- data/doc/cxxapi/ftv2folderopen.png +0 -0
- data/doc/cxxapi/ftv2lastnode.png +0 -0
- data/doc/cxxapi/ftv2link.png +0 -0
- data/doc/cxxapi/ftv2mlastnode.png +0 -0
- data/doc/cxxapi/ftv2mnode.png +0 -0
- data/doc/cxxapi/ftv2node.png +0 -0
- data/doc/cxxapi/ftv2plastnode.png +0 -0
- data/doc/cxxapi/ftv2pnode.png +0 -0
- data/doc/cxxapi/ftv2vertline.png +0 -0
- data/doc/cxxapi/functions.html +0 -103
- data/doc/cxxapi/functions_0x62.html +0 -82
- data/doc/cxxapi/functions_0x63.html +0 -102
- data/doc/cxxapi/functions_0x64.html +0 -102
- data/doc/cxxapi/functions_0x65.html +0 -88
- data/doc/cxxapi/functions_0x66.html +0 -100
- data/doc/cxxapi/functions_0x67.html +0 -167
- data/doc/cxxapi/functions_0x68.html +0 -88
- data/doc/cxxapi/functions_0x69.html +0 -96
- data/doc/cxxapi/functions_0x6b.html +0 -80
- data/doc/cxxapi/functions_0x6c.html +0 -88
- data/doc/cxxapi/functions_0x6d.html +0 -88
- data/doc/cxxapi/functions_0x6e.html +0 -86
- data/doc/cxxapi/functions_0x6f.html +0 -94
- data/doc/cxxapi/functions_0x70.html +0 -94
- data/doc/cxxapi/functions_0x72.html +0 -110
- data/doc/cxxapi/functions_0x73.html +0 -171
- data/doc/cxxapi/functions_0x74.html +0 -85
- data/doc/cxxapi/functions_0x75.html +0 -85
- data/doc/cxxapi/functions_0x77.html +0 -92
- data/doc/cxxapi/functions_0x7e.html +0 -79
- data/doc/cxxapi/functions_enum.html +0 -49
- data/doc/cxxapi/functions_eval.html +0 -67
- data/doc/cxxapi/functions_func.html +0 -531
- data/doc/cxxapi/functions_vars.html +0 -278
- data/doc/cxxapi/graph_legend.dot +0 -22
- data/doc/cxxapi/graph_legend.html +0 -92
- data/doc/cxxapi/graph_legend.png +0 -0
- data/doc/cxxapi/group__Core.html +0 -46
- data/doc/cxxapi/group__Core.map +0 -3
- data/doc/cxxapi/group__Core.png +0 -0
- data/doc/cxxapi/group__Exceptions.html +0 -53
- data/doc/cxxapi/group__Hooks.html +0 -42
- data/doc/cxxapi/group__Hooks.map +0 -3
- data/doc/cxxapi/group__Hooks.png +0 -0
- data/doc/cxxapi/group__Support.html +0 -538
- data/doc/cxxapi/hierarchy.html +0 -101
- data/doc/cxxapi/index.html +0 -16
- data/doc/cxxapi/inherit__graph__0.map +0 -3
- data/doc/cxxapi/inherit__graph__0.md5 +0 -1
- data/doc/cxxapi/inherit__graph__0.png +0 -0
- data/doc/cxxapi/inherit__graph__1.map +0 -3
- data/doc/cxxapi/inherit__graph__1.md5 +0 -1
- data/doc/cxxapi/inherit__graph__1.png +0 -0
- data/doc/cxxapi/inherit__graph__10.map +0 -3
- data/doc/cxxapi/inherit__graph__10.md5 +0 -1
- data/doc/cxxapi/inherit__graph__10.png +0 -0
- data/doc/cxxapi/inherit__graph__11.map +0 -4
- data/doc/cxxapi/inherit__graph__11.md5 +0 -1
- data/doc/cxxapi/inherit__graph__11.png +0 -0
- data/doc/cxxapi/inherit__graph__12.map +0 -3
- data/doc/cxxapi/inherit__graph__12.md5 +0 -1
- data/doc/cxxapi/inherit__graph__12.png +0 -0
- data/doc/cxxapi/inherit__graph__13.map +0 -3
- data/doc/cxxapi/inherit__graph__13.md5 +0 -1
- data/doc/cxxapi/inherit__graph__13.png +0 -0
- data/doc/cxxapi/inherit__graph__14.map +0 -3
- data/doc/cxxapi/inherit__graph__14.md5 +0 -1
- data/doc/cxxapi/inherit__graph__14.png +0 -0
- data/doc/cxxapi/inherit__graph__15.map +0 -3
- data/doc/cxxapi/inherit__graph__15.md5 +0 -1
- data/doc/cxxapi/inherit__graph__15.png +0 -0
- data/doc/cxxapi/inherit__graph__16.map +0 -5
- data/doc/cxxapi/inherit__graph__16.md5 +0 -1
- data/doc/cxxapi/inherit__graph__16.png +0 -0
- data/doc/cxxapi/inherit__graph__17.map +0 -3
- data/doc/cxxapi/inherit__graph__17.md5 +0 -1
- data/doc/cxxapi/inherit__graph__17.png +0 -0
- data/doc/cxxapi/inherit__graph__18.map +0 -3
- data/doc/cxxapi/inherit__graph__18.md5 +0 -1
- data/doc/cxxapi/inherit__graph__18.png +0 -0
- data/doc/cxxapi/inherit__graph__19.map +0 -4
- data/doc/cxxapi/inherit__graph__19.md5 +0 -1
- data/doc/cxxapi/inherit__graph__19.png +0 -0
- data/doc/cxxapi/inherit__graph__2.map +0 -3
- data/doc/cxxapi/inherit__graph__2.md5 +0 -1
- data/doc/cxxapi/inherit__graph__2.png +0 -0
- data/doc/cxxapi/inherit__graph__20.map +0 -3
- data/doc/cxxapi/inherit__graph__20.md5 +0 -1
- data/doc/cxxapi/inherit__graph__20.png +0 -0
- data/doc/cxxapi/inherit__graph__21.map +0 -3
- data/doc/cxxapi/inherit__graph__21.md5 +0 -1
- data/doc/cxxapi/inherit__graph__21.png +0 -0
- data/doc/cxxapi/inherit__graph__22.map +0 -3
- data/doc/cxxapi/inherit__graph__22.md5 +0 -1
- data/doc/cxxapi/inherit__graph__22.png +0 -0
- data/doc/cxxapi/inherit__graph__23.map +0 -3
- data/doc/cxxapi/inherit__graph__23.md5 +0 -1
- data/doc/cxxapi/inherit__graph__23.png +0 -0
- data/doc/cxxapi/inherit__graph__24.map +0 -3
- data/doc/cxxapi/inherit__graph__24.md5 +0 -1
- data/doc/cxxapi/inherit__graph__24.png +0 -0
- data/doc/cxxapi/inherit__graph__25.map +0 -3
- data/doc/cxxapi/inherit__graph__25.md5 +0 -1
- data/doc/cxxapi/inherit__graph__25.png +0 -0
- data/doc/cxxapi/inherit__graph__26.map +0 -3
- data/doc/cxxapi/inherit__graph__26.md5 +0 -1
- data/doc/cxxapi/inherit__graph__26.png +0 -0
- data/doc/cxxapi/inherit__graph__27.map +0 -3
- data/doc/cxxapi/inherit__graph__27.md5 +0 -1
- data/doc/cxxapi/inherit__graph__27.png +0 -0
- data/doc/cxxapi/inherit__graph__28.map +0 -3
- data/doc/cxxapi/inherit__graph__28.md5 +0 -1
- data/doc/cxxapi/inherit__graph__28.png +0 -0
- data/doc/cxxapi/inherit__graph__29.map +0 -3
- data/doc/cxxapi/inherit__graph__29.md5 +0 -1
- data/doc/cxxapi/inherit__graph__29.png +0 -0
- data/doc/cxxapi/inherit__graph__3.map +0 -4
- data/doc/cxxapi/inherit__graph__3.md5 +0 -1
- data/doc/cxxapi/inherit__graph__3.png +0 -0
- data/doc/cxxapi/inherit__graph__30.map +0 -3
- data/doc/cxxapi/inherit__graph__30.md5 +0 -1
- data/doc/cxxapi/inherit__graph__30.png +0 -0
- data/doc/cxxapi/inherit__graph__31.map +0 -4
- data/doc/cxxapi/inherit__graph__31.md5 +0 -1
- data/doc/cxxapi/inherit__graph__31.png +0 -0
- data/doc/cxxapi/inherit__graph__32.map +0 -3
- data/doc/cxxapi/inherit__graph__32.md5 +0 -1
- data/doc/cxxapi/inherit__graph__32.png +0 -0
- data/doc/cxxapi/inherit__graph__33.map +0 -3
- data/doc/cxxapi/inherit__graph__33.md5 +0 -1
- data/doc/cxxapi/inherit__graph__33.png +0 -0
- data/doc/cxxapi/inherit__graph__34.map +0 -3
- data/doc/cxxapi/inherit__graph__34.md5 +0 -1
- data/doc/cxxapi/inherit__graph__34.png +0 -0
- data/doc/cxxapi/inherit__graph__35.map +0 -3
- data/doc/cxxapi/inherit__graph__35.md5 +0 -1
- data/doc/cxxapi/inherit__graph__35.png +0 -0
- data/doc/cxxapi/inherit__graph__36.map +0 -5
- data/doc/cxxapi/inherit__graph__36.md5 +0 -1
- data/doc/cxxapi/inherit__graph__36.png +0 -0
- data/doc/cxxapi/inherit__graph__37.map +0 -3
- data/doc/cxxapi/inherit__graph__37.md5 +0 -1
- data/doc/cxxapi/inherit__graph__37.png +0 -0
- data/doc/cxxapi/inherit__graph__38.map +0 -3
- data/doc/cxxapi/inherit__graph__38.md5 +0 -1
- data/doc/cxxapi/inherit__graph__38.png +0 -0
- data/doc/cxxapi/inherit__graph__39.map +0 -3
- data/doc/cxxapi/inherit__graph__39.md5 +0 -1
- data/doc/cxxapi/inherit__graph__39.png +0 -0
- data/doc/cxxapi/inherit__graph__4.map +0 -3
- data/doc/cxxapi/inherit__graph__4.md5 +0 -1
- data/doc/cxxapi/inherit__graph__4.png +0 -0
- data/doc/cxxapi/inherit__graph__40.map +0 -3
- data/doc/cxxapi/inherit__graph__40.md5 +0 -1
- data/doc/cxxapi/inherit__graph__40.png +0 -0
- data/doc/cxxapi/inherit__graph__41.map +0 -3
- data/doc/cxxapi/inherit__graph__41.md5 +0 -1
- data/doc/cxxapi/inherit__graph__41.png +0 -0
- data/doc/cxxapi/inherit__graph__5.map +0 -3
- data/doc/cxxapi/inherit__graph__5.md5 +0 -1
- data/doc/cxxapi/inherit__graph__5.png +0 -0
- data/doc/cxxapi/inherit__graph__6.map +0 -3
- data/doc/cxxapi/inherit__graph__6.md5 +0 -1
- data/doc/cxxapi/inherit__graph__6.png +0 -0
- data/doc/cxxapi/inherit__graph__7.map +0 -3
- data/doc/cxxapi/inherit__graph__7.md5 +0 -1
- data/doc/cxxapi/inherit__graph__7.png +0 -0
- data/doc/cxxapi/inherit__graph__8.map +0 -3
- data/doc/cxxapi/inherit__graph__8.md5 +0 -1
- data/doc/cxxapi/inherit__graph__8.png +0 -0
- data/doc/cxxapi/inherit__graph__9.map +0 -3
- data/doc/cxxapi/inherit__graph__9.md5 +0 -1
- data/doc/cxxapi/inherit__graph__9.png +0 -0
- data/doc/cxxapi/inherits.html +0 -165
- data/doc/cxxapi/main.html +0 -28
- data/doc/cxxapi/modules.html +0 -36
- data/doc/cxxapi/namespacePassenger.html +0 -585
- data/doc/cxxapi/namespacemembers.html +0 -190
- data/doc/cxxapi/namespacemembers_enum.html +0 -48
- data/doc/cxxapi/namespacemembers_eval.html +0 -57
- data/doc/cxxapi/namespacemembers_func.html +0 -114
- data/doc/cxxapi/namespacemembers_type.html +0 -54
- data/doc/cxxapi/namespaces.html +0 -37
- data/doc/cxxapi/nginx_2Configuration_8h_source.html +0 -126
- data/doc/cxxapi/ngx__http__passenger__module_8h_source.html +0 -95
- data/doc/cxxapi/structPassenger_1_1MessageServer_1_1DisconnectEventBroadcastGuard-members.html +0 -36
- data/doc/cxxapi/structPassenger_1_1MessageServer_1_1DisconnectEventBroadcastGuard.html +0 -51
- data/doc/cxxapi/structPassenger_1_1PoolOptions-members.html +0 -67
- data/doc/cxxapi/structPassenger_1_1PoolOptions.html +0 -647
- data/doc/cxxapi/structPassenger_1_1StaticString_1_1Hash-members.html +0 -36
- data/doc/cxxapi/structPassenger_1_1StaticString_1_1Hash.html +0 -51
- data/doc/cxxapi/tab_b.gif +0 -0
- data/doc/cxxapi/tab_l.gif +0 -0
- data/doc/cxxapi/tab_r.gif +0 -0
- data/doc/cxxapi/tabs.css +0 -105
- data/doc/cxxapi/tree.html +0 -249
- data/doc/template/horo.rb +0 -613
- data/ext/libev/config.h +0 -122
- data/ext/nginx/HttpStatusExtractor.h +0 -351
|
@@ -1,776 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
2
|
-
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
3
|
-
<head>
|
|
4
|
-
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
5
|
-
<title>Passenger: MessageChannel.h Source File</title>
|
|
6
|
-
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
7
|
-
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
|
|
8
|
-
</head>
|
|
9
|
-
<body>
|
|
10
|
-
<!-- Generated by Doxygen 1.6.2 -->
|
|
11
|
-
<div class="navigation" id="top">
|
|
12
|
-
<div class="tabs">
|
|
13
|
-
<ul>
|
|
14
|
-
<li><a href="main.html"><span>Main Page</span></a></li>
|
|
15
|
-
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
16
|
-
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
17
|
-
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
18
|
-
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
19
|
-
</ul>
|
|
20
|
-
</div>
|
|
21
|
-
<div class="tabs">
|
|
22
|
-
<ul>
|
|
23
|
-
<li><a href="files.html"><span>File List</span></a></li>
|
|
24
|
-
</ul>
|
|
25
|
-
</div>
|
|
26
|
-
<h1>MessageChannel.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
|
|
27
|
-
<a name="l00002"></a>00002 <span class="comment"> * Phusion Passenger - http://www.modrails.com/</span>
|
|
28
|
-
<a name="l00003"></a>00003 <span class="comment"> * Copyright (c) 2010 Phusion</span>
|
|
29
|
-
<a name="l00004"></a>00004 <span class="comment"> *</span>
|
|
30
|
-
<a name="l00005"></a>00005 <span class="comment"> * "Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.</span>
|
|
31
|
-
<a name="l00006"></a>00006 <span class="comment"> *</span>
|
|
32
|
-
<a name="l00007"></a>00007 <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a copy</span>
|
|
33
|
-
<a name="l00008"></a>00008 <span class="comment"> * of this software and associated documentation files (the "Software"), to deal</span>
|
|
34
|
-
<a name="l00009"></a>00009 <span class="comment"> * in the Software without restriction, including without limitation the rights</span>
|
|
35
|
-
<a name="l00010"></a>00010 <span class="comment"> * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span>
|
|
36
|
-
<a name="l00011"></a>00011 <span class="comment"> * copies of the Software, and to permit persons to whom the Software is</span>
|
|
37
|
-
<a name="l00012"></a>00012 <span class="comment"> * furnished to do so, subject to the following conditions:</span>
|
|
38
|
-
<a name="l00013"></a>00013 <span class="comment"> *</span>
|
|
39
|
-
<a name="l00014"></a>00014 <span class="comment"> * The above copyright notice and this permission notice shall be included in</span>
|
|
40
|
-
<a name="l00015"></a>00015 <span class="comment"> * all copies or substantial portions of the Software.</span>
|
|
41
|
-
<a name="l00016"></a>00016 <span class="comment"> *</span>
|
|
42
|
-
<a name="l00017"></a>00017 <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span>
|
|
43
|
-
<a name="l00018"></a>00018 <span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
|
|
44
|
-
<a name="l00019"></a>00019 <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
|
|
45
|
-
<a name="l00020"></a>00020 <span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
|
|
46
|
-
<a name="l00021"></a>00021 <span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span>
|
|
47
|
-
<a name="l00022"></a>00022 <span class="comment"> * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</span>
|
|
48
|
-
<a name="l00023"></a>00023 <span class="comment"> * THE SOFTWARE.</span>
|
|
49
|
-
<a name="l00024"></a>00024 <span class="comment"> */</span>
|
|
50
|
-
<a name="l00025"></a>00025 <span class="preprocessor">#ifndef _PASSENGER_MESSAGE_CHANNEL_H_</span>
|
|
51
|
-
<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define _PASSENGER_MESSAGE_CHANNEL_H_</span>
|
|
52
|
-
<a name="l00027"></a>00027 <span class="preprocessor"></span>
|
|
53
|
-
<a name="l00028"></a>00028 <span class="preprocessor">#include <oxt/system_calls.hpp></span>
|
|
54
|
-
<a name="l00029"></a>00029 <span class="preprocessor">#include <oxt/macros.hpp></span>
|
|
55
|
-
<a name="l00030"></a>00030
|
|
56
|
-
<a name="l00031"></a>00031 <span class="preprocessor">#include <algorithm></span>
|
|
57
|
-
<a name="l00032"></a>00032 <span class="preprocessor">#include <string></span>
|
|
58
|
-
<a name="l00033"></a>00033 <span class="preprocessor">#include <list></span>
|
|
59
|
-
<a name="l00034"></a>00034 <span class="preprocessor">#include <vector></span>
|
|
60
|
-
<a name="l00035"></a>00035
|
|
61
|
-
<a name="l00036"></a>00036 <span class="preprocessor">#include <sys/types.h></span>
|
|
62
|
-
<a name="l00037"></a>00037 <span class="preprocessor">#include <sys/socket.h></span>
|
|
63
|
-
<a name="l00038"></a>00038 <span class="preprocessor">#include <sys/uio.h></span>
|
|
64
|
-
<a name="l00039"></a>00039 <span class="preprocessor">#include <arpa/inet.h></span>
|
|
65
|
-
<a name="l00040"></a>00040 <span class="preprocessor">#include <errno.h></span>
|
|
66
|
-
<a name="l00041"></a>00041 <span class="preprocessor">#include <unistd.h></span>
|
|
67
|
-
<a name="l00042"></a>00042 <span class="preprocessor">#include <cstdarg></span>
|
|
68
|
-
<a name="l00043"></a>00043 <span class="preprocessor">#include <cmath></span>
|
|
69
|
-
<a name="l00044"></a>00044 <span class="preprocessor">#if !APR_HAVE_IOVEC</span>
|
|
70
|
-
<a name="l00045"></a>00045 <span class="preprocessor"></span> <span class="comment">// We don't want apr_want.h to redefine 'struct iovec'.</span>
|
|
71
|
-
<a name="l00046"></a>00046 <span class="comment">// http://groups.google.com/group/phusion-passenger/browse_thread/thread/7e162f60df212e9c</span>
|
|
72
|
-
<a name="l00047"></a>00047 <span class="preprocessor"> #undef APR_HAVE_IOVEC</span>
|
|
73
|
-
<a name="l00048"></a>00048 <span class="preprocessor"></span><span class="preprocessor"> #define APR_HAVE_IOVEC 1</span>
|
|
74
|
-
<a name="l00049"></a>00049 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
|
|
75
|
-
<a name="l00050"></a>00050 <span class="preprocessor"></span>
|
|
76
|
-
<a name="l00051"></a>00051 <span class="preprocessor">#include "StaticString.h"</span>
|
|
77
|
-
<a name="l00052"></a>00052 <span class="preprocessor">#include "Exceptions.h"</span>
|
|
78
|
-
<a name="l00053"></a>00053 <span class="preprocessor">#include "Utils/Timer.h"</span>
|
|
79
|
-
<a name="l00054"></a>00054 <span class="preprocessor">#include "Utils/MemZeroGuard.h"</span>
|
|
80
|
-
<a name="l00055"></a>00055 <span class="preprocessor">#include "Utils/IOUtils.h"</span>
|
|
81
|
-
<a name="l00056"></a>00056
|
|
82
|
-
<a name="l00057"></a>00057 <span class="keyword">namespace </span>Passenger {
|
|
83
|
-
<a name="l00058"></a>00058
|
|
84
|
-
<a name="l00059"></a>00059 <span class="keyword">using namespace </span>std;
|
|
85
|
-
<a name="l00060"></a>00060 <span class="keyword">using namespace </span>oxt;
|
|
86
|
-
<a name="l00061"></a>00061
|
|
87
|
-
<a name="l00062"></a>00062 <span class="comment"></span>
|
|
88
|
-
<a name="l00063"></a>00063 <span class="comment">/**</span>
|
|
89
|
-
<a name="l00064"></a>00064 <span class="comment"> * Convenience class for I/O operations on file descriptors.</span>
|
|
90
|
-
<a name="l00065"></a>00065 <span class="comment"> *</span>
|
|
91
|
-
<a name="l00066"></a>00066 <span class="comment"> * This class provides convenience methods for:</span>
|
|
92
|
-
<a name="l00067"></a>00067 <span class="comment"> * - sending and receiving raw data over a file descriptor.</span>
|
|
93
|
-
<a name="l00068"></a>00068 <span class="comment"> * - sending and receiving messages over a file descriptor.</span>
|
|
94
|
-
<a name="l00069"></a>00069 <span class="comment"> * - file descriptor passing over a Unix socket.</span>
|
|
95
|
-
<a name="l00070"></a>00070 <span class="comment"> * - data size limit enforcement and time constraint enforcement.</span>
|
|
96
|
-
<a name="l00071"></a>00071 <span class="comment"> * All of these methods use exceptions for error reporting.</span>
|
|
97
|
-
<a name="l00072"></a>00072 <span class="comment"> *</span>
|
|
98
|
-
<a name="l00073"></a>00073 <span class="comment"> * There are two kinds of messages:</span>
|
|
99
|
-
<a name="l00074"></a>00074 <span class="comment"> * - Array messages. These are just a list of strings, and the message</span>
|
|
100
|
-
<a name="l00075"></a>00075 <span class="comment"> * itself has a specific length. The contained strings may not</span>
|
|
101
|
-
<a name="l00076"></a>00076 <span class="comment"> * contain NUL characters (<tt>'\\0'</tt>). Note that an array message</span>
|
|
102
|
-
<a name="l00077"></a>00077 <span class="comment"> * must have at least one element.</span>
|
|
103
|
-
<a name="l00078"></a>00078 <span class="comment"> * - Scalar messages. These are byte strings which may contain arbitrary</span>
|
|
104
|
-
<a name="l00079"></a>00079 <span class="comment"> * binary data. Scalar messages also have a specific length.</span>
|
|
105
|
-
<a name="l00080"></a>00080 <span class="comment"> * The protocol is designed to be low overhead, easy to implement and</span>
|
|
106
|
-
<a name="l00081"></a>00081 <span class="comment"> * easy to parse.</span>
|
|
107
|
-
<a name="l00082"></a>00082 <span class="comment"> *</span>
|
|
108
|
-
<a name="l00083"></a>00083 <span class="comment"> * MessageChannel is to be wrapped around a file descriptor. For example:</span>
|
|
109
|
-
<a name="l00084"></a>00084 <span class="comment"> * @code</span>
|
|
110
|
-
<a name="l00085"></a>00085 <span class="comment"> * int p[2];</span>
|
|
111
|
-
<a name="l00086"></a>00086 <span class="comment"> * pipe(p);</span>
|
|
112
|
-
<a name="l00087"></a>00087 <span class="comment"> * MessageChannel channel1(p[0]);</span>
|
|
113
|
-
<a name="l00088"></a>00088 <span class="comment"> * MessageChannel channel2(p[1]);</span>
|
|
114
|
-
<a name="l00089"></a>00089 <span class="comment"> * </span>
|
|
115
|
-
<a name="l00090"></a>00090 <span class="comment"> * // Send an array message.</span>
|
|
116
|
-
<a name="l00091"></a>00091 <span class="comment"> * channel2.write("hello", "world !!", NULL);</span>
|
|
117
|
-
<a name="l00092"></a>00092 <span class="comment"> * list<string> args;</span>
|
|
118
|
-
<a name="l00093"></a>00093 <span class="comment"> * channel1.read(args); // args now contains { "hello", "world !!" }</span>
|
|
119
|
-
<a name="l00094"></a>00094 <span class="comment"> *</span>
|
|
120
|
-
<a name="l00095"></a>00095 <span class="comment"> * // Send a scalar message.</span>
|
|
121
|
-
<a name="l00096"></a>00096 <span class="comment"> * channel2.writeScalar("some long string which can contain arbitrary binary data");</span>
|
|
122
|
-
<a name="l00097"></a>00097 <span class="comment"> * string str;</span>
|
|
123
|
-
<a name="l00098"></a>00098 <span class="comment"> * channel1.readScalar(str);</span>
|
|
124
|
-
<a name="l00099"></a>00099 <span class="comment"> * @endcode</span>
|
|
125
|
-
<a name="l00100"></a>00100 <span class="comment"> *</span>
|
|
126
|
-
<a name="l00101"></a>00101 <span class="comment"> * The life time of a MessageChannel is independent from that of the</span>
|
|
127
|
-
<a name="l00102"></a>00102 <span class="comment"> * wrapped file descriptor. If a MessageChannel object is destroyed,</span>
|
|
128
|
-
<a name="l00103"></a>00103 <span class="comment"> * the file descriptor is not automatically closed. Call close()</span>
|
|
129
|
-
<a name="l00104"></a>00104 <span class="comment"> * if you want to close the file descriptor.</span>
|
|
130
|
-
<a name="l00105"></a>00105 <span class="comment"> *</span>
|
|
131
|
-
<a name="l00106"></a>00106 <span class="comment"> * @note I/O operations are not buffered.</span>
|
|
132
|
-
<a name="l00107"></a>00107 <span class="comment"> * @note Be careful with mixing the sending/receiving of array messages,</span>
|
|
133
|
-
<a name="l00108"></a>00108 <span class="comment"> * scalar messages and file descriptors. If you send a collection of any</span>
|
|
134
|
-
<a name="l00109"></a>00109 <span class="comment"> * of these in a specific order, then the receiving side must receive them</span>
|
|
135
|
-
<a name="l00110"></a>00110 <span class="comment"> * in the exact some order. So suppose you first send a message, then a</span>
|
|
136
|
-
<a name="l00111"></a>00111 <span class="comment"> * file descriptor, then a scalar, then the receiving side must first</span>
|
|
137
|
-
<a name="l00112"></a>00112 <span class="comment"> * receive a message, then a file descriptor, then a scalar. If the</span>
|
|
138
|
-
<a name="l00113"></a>00113 <span class="comment"> * receiving side does things in the wrong order then bad things will</span>
|
|
139
|
-
<a name="l00114"></a>00114 <span class="comment"> * happen.</span>
|
|
140
|
-
<a name="l00115"></a>00115 <span class="comment"> * @note MessageChannel is not thread-safe, but is reentrant.</span>
|
|
141
|
-
<a name="l00116"></a>00116 <span class="comment"> * @note Some methods throw SecurityException and TimeoutException. When these</span>
|
|
142
|
-
<a name="l00117"></a>00117 <span class="comment"> * exceptions are thrown, the channel will be left in an inconsistent state</span>
|
|
143
|
-
<a name="l00118"></a>00118 <span class="comment"> * because only parts of the data have been read. You should close the channel</span>
|
|
144
|
-
<a name="l00119"></a>00119 <span class="comment"> * after having caught these exceptions.</span>
|
|
145
|
-
<a name="l00120"></a>00120 <span class="comment"> *</span>
|
|
146
|
-
<a name="l00121"></a>00121 <span class="comment"> * @ingroup Support</span>
|
|
147
|
-
<a name="l00122"></a>00122 <span class="comment"> */</span>
|
|
148
|
-
<a name="l00123"></a><a class="code" href="classPassenger_1_1MessageChannel.html">00123</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a> {
|
|
149
|
-
<a name="l00124"></a>00124 <span class="keyword">private</span>:
|
|
150
|
-
<a name="l00125"></a>00125 <span class="keyword">const</span> <span class="keyword">static</span> <span class="keywordtype">char</span> DELIMITER = <span class="charliteral">'\0'</span>;
|
|
151
|
-
<a name="l00126"></a>00126 <span class="keywordtype">int</span> fd;
|
|
152
|
-
<a name="l00127"></a>00127
|
|
153
|
-
<a name="l00128"></a>00128 <span class="preprocessor"> #ifdef __OpenBSD__</span>
|
|
154
|
-
<a name="l00129"></a>00129 <span class="preprocessor"></span> <span class="keyword">typedef</span> u_int32_t uint32_t;
|
|
155
|
-
<a name="l00130"></a>00130 <span class="keyword">typedef</span> u_int16_t uint16_t;
|
|
156
|
-
<a name="l00131"></a>00131 <span class="preprocessor"> #endif</span>
|
|
157
|
-
<a name="l00132"></a>00132 <span class="preprocessor"></span>
|
|
158
|
-
<a name="l00133"></a>00133 <span class="keyword">public</span>:<span class="comment"></span>
|
|
159
|
-
<a name="l00134"></a>00134 <span class="comment"> /**</span>
|
|
160
|
-
<a name="l00135"></a>00135 <span class="comment"> * Construct a new MessageChannel with no underlying file descriptor.</span>
|
|
161
|
-
<a name="l00136"></a>00136 <span class="comment"> * Thus the resulting MessageChannel object will not be usable.</span>
|
|
162
|
-
<a name="l00137"></a>00137 <span class="comment"> * This constructor exists to allow one to declare an "empty"</span>
|
|
163
|
-
<a name="l00138"></a>00138 <span class="comment"> * MessageChannel variable which is to be initialized later.</span>
|
|
164
|
-
<a name="l00139"></a>00139 <span class="comment"> */</span>
|
|
165
|
-
<a name="l00140"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a73e7c9a8e421d29558838176aff02ca4">00140</a> <a class="code" href="classPassenger_1_1MessageChannel.html#a73e7c9a8e421d29558838176aff02ca4" title="Construct a new MessageChannel with no underlying file descriptor.">MessageChannel</a>() {
|
|
166
|
-
<a name="l00141"></a>00141 this->fd = -1;
|
|
167
|
-
<a name="l00142"></a>00142 }
|
|
168
|
-
<a name="l00143"></a>00143 <span class="comment"></span>
|
|
169
|
-
<a name="l00144"></a>00144 <span class="comment"> /**</span>
|
|
170
|
-
<a name="l00145"></a>00145 <span class="comment"> * Construct a new MessageChannel with the given file descriptor.</span>
|
|
171
|
-
<a name="l00146"></a>00146 <span class="comment"> */</span>
|
|
172
|
-
<a name="l00147"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a486b6e74c4d0973eefbcfde65f898ca7">00147</a> <a class="code" href="classPassenger_1_1MessageChannel.html#a486b6e74c4d0973eefbcfde65f898ca7" title="Construct a new MessageChannel with the given file descriptor.">MessageChannel</a>(<span class="keywordtype">int</span> fd) {
|
|
173
|
-
<a name="l00148"></a>00148 this->fd = fd;
|
|
174
|
-
<a name="l00149"></a>00149 }
|
|
175
|
-
<a name="l00150"></a>00150 <span class="comment"></span>
|
|
176
|
-
<a name="l00151"></a>00151 <span class="comment"> /**</span>
|
|
177
|
-
<a name="l00152"></a>00152 <span class="comment"> * Returns the underlying file descriptor. -1 if it has already been closed.</span>
|
|
178
|
-
<a name="l00153"></a>00153 <span class="comment"> */</span>
|
|
179
|
-
<a name="l00154"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a0b1e25dd75783d9753f8a0d1dd42606a">00154</a> <span class="keywordtype">int</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a0b1e25dd75783d9753f8a0d1dd42606a" title="Returns the underlying file descriptor.">filenum</a>()<span class="keyword"> const </span>{
|
|
180
|
-
<a name="l00155"></a>00155 <span class="keywordflow">return</span> fd;
|
|
181
|
-
<a name="l00156"></a>00156 }
|
|
182
|
-
<a name="l00157"></a>00157 <span class="comment"></span>
|
|
183
|
-
<a name="l00158"></a>00158 <span class="comment"> /**</span>
|
|
184
|
-
<a name="l00159"></a>00159 <span class="comment"> * Returns whether close() has been called.</span>
|
|
185
|
-
<a name="l00160"></a>00160 <span class="comment"> */</span>
|
|
186
|
-
<a name="l00161"></a><a class="code" href="classPassenger_1_1MessageChannel.html#aa5ee9617bb17bdeaba30b757ecffa1b5">00161</a> <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1MessageChannel.html#aa5ee9617bb17bdeaba30b757ecffa1b5" title="Returns whether close() has been called.">connected</a>()<span class="keyword"> const </span>{
|
|
187
|
-
<a name="l00162"></a>00162 <span class="keywordflow">return</span> fd != -1;
|
|
188
|
-
<a name="l00163"></a>00163 }
|
|
189
|
-
<a name="l00164"></a>00164 <span class="comment"></span>
|
|
190
|
-
<a name="l00165"></a>00165 <span class="comment"> /**</span>
|
|
191
|
-
<a name="l00166"></a>00166 <span class="comment"> * Close the underlying file descriptor. If this method is called multiple</span>
|
|
192
|
-
<a name="l00167"></a>00167 <span class="comment"> * times, the file descriptor will only be closed the first time.</span>
|
|
193
|
-
<a name="l00168"></a>00168 <span class="comment"> *</span>
|
|
194
|
-
<a name="l00169"></a>00169 <span class="comment"> * @throw SystemException</span>
|
|
195
|
-
<a name="l00170"></a>00170 <span class="comment"> * @throw boost::thread_interrupted</span>
|
|
196
|
-
<a name="l00171"></a>00171 <span class="comment"> * @post filenum() == -1</span>
|
|
197
|
-
<a name="l00172"></a>00172 <span class="comment"> * @post !connected()</span>
|
|
198
|
-
<a name="l00173"></a>00173 <span class="comment"> */</span>
|
|
199
|
-
<a name="l00174"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a06309e208fc5e10642a2e9bbe0f351eb">00174</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a06309e208fc5e10642a2e9bbe0f351eb" title="Close the underlying file descriptor.">close</a>() {
|
|
200
|
-
<a name="l00175"></a>00175 <span class="keywordflow">if</span> (fd != -1) {
|
|
201
|
-
<a name="l00176"></a>00176 <span class="keywordtype">int</span> ret = <a class="code" href="classPassenger_1_1MessageChannel.html#a06309e208fc5e10642a2e9bbe0f351eb" title="Close the underlying file descriptor.">syscalls::close</a>(fd);
|
|
202
|
-
<a name="l00177"></a>00177 fd = -1;
|
|
203
|
-
<a name="l00178"></a>00178 <span class="keywordflow">if</span> (ret == -1) {
|
|
204
|
-
<a name="l00179"></a>00179 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">"Cannot close file descriptor"</span>, errno);
|
|
205
|
-
<a name="l00180"></a>00180 }
|
|
206
|
-
<a name="l00181"></a>00181 }
|
|
207
|
-
<a name="l00182"></a>00182 }
|
|
208
|
-
<a name="l00183"></a>00183 <span class="comment"></span>
|
|
209
|
-
<a name="l00184"></a>00184 <span class="comment"> /**</span>
|
|
210
|
-
<a name="l00185"></a>00185 <span class="comment"> * Send an array message, which consists of the given elements, over the underlying</span>
|
|
211
|
-
<a name="l00186"></a>00186 <span class="comment"> * file descriptor.</span>
|
|
212
|
-
<a name="l00187"></a>00187 <span class="comment"> *</span>
|
|
213
|
-
<a name="l00188"></a>00188 <span class="comment"> * @param args An object which contains the message elements. This object must</span>
|
|
214
|
-
<a name="l00189"></a>00189 <span class="comment"> * support STL-style iteration, and each iterator must have an</span>
|
|
215
|
-
<a name="l00190"></a>00190 <span class="comment"> * std::string as value. Use the StringArrayType and</span>
|
|
216
|
-
<a name="l00191"></a>00191 <span class="comment"> * StringArrayConstIteratorType template parameters to specify the exact type names.</span>
|
|
217
|
-
<a name="l00192"></a>00192 <span class="comment"> * @throws SystemException An error occured while writing the data to the file descriptor.</span>
|
|
218
|
-
<a name="l00193"></a>00193 <span class="comment"> * @throws boost::thread_interrupted</span>
|
|
219
|
-
<a name="l00194"></a>00194 <span class="comment"> * @pre None of the message elements may contain a NUL character (<tt>'\\0'</tt>).</span>
|
|
220
|
-
<a name="l00195"></a>00195 <span class="comment"> * @see read(), write(const char *, ...)</span>
|
|
221
|
-
<a name="l00196"></a>00196 <span class="comment"> */</span>
|
|
222
|
-
<a name="l00197"></a>00197 <span class="keyword">template</span><<span class="keyword">typename</span> StringArrayType, <span class="keyword">typename</span> StringArrayConstIteratorType>
|
|
223
|
-
<a name="l00198"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a150f68bc47e060dcc6ca35bee047914d">00198</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a150f68bc47e060dcc6ca35bee047914d" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(<span class="keyword">const</span> StringArrayType &args) {
|
|
224
|
-
<a name="l00199"></a>00199 StringArrayConstIteratorType it;
|
|
225
|
-
<a name="l00200"></a>00200 <span class="keywordtype">string</span> data;
|
|
226
|
-
<a name="l00201"></a>00201 uint16_t dataSize = 0;
|
|
227
|
-
<a name="l00202"></a>00202
|
|
228
|
-
<a name="l00203"></a>00203 <span class="keywordflow">for</span> (it = args.begin(); it != args.end(); it++) {
|
|
229
|
-
<a name="l00204"></a>00204 dataSize += it->size() + 1;
|
|
230
|
-
<a name="l00205"></a>00205 }
|
|
231
|
-
<a name="l00206"></a>00206 data.reserve(dataSize + <span class="keyword">sizeof</span>(dataSize));
|
|
232
|
-
<a name="l00207"></a>00207 dataSize = htons(dataSize);
|
|
233
|
-
<a name="l00208"></a>00208 data.append((<span class="keyword">const</span> <span class="keywordtype">char</span> *) &dataSize, <span class="keyword">sizeof</span>(dataSize));
|
|
234
|
-
<a name="l00209"></a>00209 <span class="keywordflow">for</span> (it = args.begin(); it != args.end(); it++) {
|
|
235
|
-
<a name="l00210"></a>00210 data.append(*it);
|
|
236
|
-
<a name="l00211"></a>00211 data.append(1, DELIMITER);
|
|
237
|
-
<a name="l00212"></a>00212 }
|
|
238
|
-
<a name="l00213"></a>00213
|
|
239
|
-
<a name="l00214"></a>00214 writeExact(fd, data);
|
|
240
|
-
<a name="l00215"></a>00215 }
|
|
241
|
-
<a name="l00216"></a>00216 <span class="comment"></span>
|
|
242
|
-
<a name="l00217"></a>00217 <span class="comment"> /**</span>
|
|
243
|
-
<a name="l00218"></a>00218 <span class="comment"> * Send an array message, which consists of the given elements, over the underlying</span>
|
|
244
|
-
<a name="l00219"></a>00219 <span class="comment"> * file descriptor.</span>
|
|
245
|
-
<a name="l00220"></a>00220 <span class="comment"> *</span>
|
|
246
|
-
<a name="l00221"></a>00221 <span class="comment"> * @param args The message elements.</span>
|
|
247
|
-
<a name="l00222"></a>00222 <span class="comment"> * @throws SystemException An error occured while writing the data to the file descriptor.</span>
|
|
248
|
-
<a name="l00223"></a>00223 <span class="comment"> * @throws boost::thread_interrupted</span>
|
|
249
|
-
<a name="l00224"></a>00224 <span class="comment"> * @pre None of the message elements may contain a NUL character (<tt>'\\0'</tt>).</span>
|
|
250
|
-
<a name="l00225"></a>00225 <span class="comment"> * @see read(), write(const char *, ...)</span>
|
|
251
|
-
<a name="l00226"></a>00226 <span class="comment"> */</span>
|
|
252
|
-
<a name="l00227"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a9ad7a978cf8409e01ab2f0a2b6be5a0a">00227</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a9ad7a978cf8409e01ab2f0a2b6be5a0a" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(<span class="keyword">const</span> list<string> &args) {
|
|
253
|
-
<a name="l00228"></a>00228 write<list<string>, list<string>::const_iterator>(args);
|
|
254
|
-
<a name="l00229"></a>00229 }
|
|
255
|
-
<a name="l00230"></a>00230 <span class="comment"></span>
|
|
256
|
-
<a name="l00231"></a>00231 <span class="comment"> /**</span>
|
|
257
|
-
<a name="l00232"></a>00232 <span class="comment"> * Send an array message, which consists of the given elements, over the underlying</span>
|
|
258
|
-
<a name="l00233"></a>00233 <span class="comment"> * file descriptor.</span>
|
|
259
|
-
<a name="l00234"></a>00234 <span class="comment"> *</span>
|
|
260
|
-
<a name="l00235"></a>00235 <span class="comment"> * @param args The message elements.</span>
|
|
261
|
-
<a name="l00236"></a>00236 <span class="comment"> * @throws SystemException An error occured while writing the data to the file descriptor.</span>
|
|
262
|
-
<a name="l00237"></a>00237 <span class="comment"> * @throws boost::thread_interrupted</span>
|
|
263
|
-
<a name="l00238"></a>00238 <span class="comment"> * @pre None of the message elements may contain a NUL character (<tt>'\\0'</tt>).</span>
|
|
264
|
-
<a name="l00239"></a>00239 <span class="comment"> * @see read(), write(const char *, ...)</span>
|
|
265
|
-
<a name="l00240"></a>00240 <span class="comment"> */</span>
|
|
266
|
-
<a name="l00241"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a6a9bc5d72715cb7ba0e437c8851ef487">00241</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a6a9bc5d72715cb7ba0e437c8851ef487" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(<span class="keyword">const</span> vector<string> &args) {
|
|
267
|
-
<a name="l00242"></a>00242 write<vector<string>, vector<string>::const_iterator>(args);
|
|
268
|
-
<a name="l00243"></a>00243 }
|
|
269
|
-
<a name="l00244"></a>00244 <span class="comment"></span>
|
|
270
|
-
<a name="l00245"></a>00245 <span class="comment"> /**</span>
|
|
271
|
-
<a name="l00246"></a>00246 <span class="comment"> * Send an array message, which consists of the given strings, over the underlying</span>
|
|
272
|
-
<a name="l00247"></a>00247 <span class="comment"> * file descriptor. Like <tt>write(const char *name, ...)</tt> but takes a va_list</span>
|
|
273
|
-
<a name="l00248"></a>00248 <span class="comment"> * instead.</span>
|
|
274
|
-
<a name="l00249"></a>00249 <span class="comment"> *</span>
|
|
275
|
-
<a name="l00250"></a>00250 <span class="comment"> * @throws SystemException An error occured while writing the data to the file descriptor.</span>
|
|
276
|
-
<a name="l00251"></a>00251 <span class="comment"> * @throws boost::thread_interrupted</span>
|
|
277
|
-
<a name="l00252"></a>00252 <span class="comment"> * @pre None of the message elements may contain a NUL character (<tt>'\\0'</tt>).</span>
|
|
278
|
-
<a name="l00253"></a>00253 <span class="comment"> */</span>
|
|
279
|
-
<a name="l00254"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a70cc924c1ce7e2cedcbab61155d3aec9">00254</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a70cc924c1ce7e2cedcbab61155d3aec9" title="Send an array message, which consists of the given strings, over the underlying file...">write</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, va_list &ap) {
|
|
280
|
-
<a name="l00255"></a>00255 list<string> args;
|
|
281
|
-
<a name="l00256"></a>00256 args.push_back(name);
|
|
282
|
-
<a name="l00257"></a>00257
|
|
283
|
-
<a name="l00258"></a>00258 <span class="keywordflow">while</span> (<span class="keyword">true</span>) {
|
|
284
|
-
<a name="l00259"></a>00259 <span class="keyword">const</span> <span class="keywordtype">char</span> *arg = va_arg(ap, <span class="keyword">const</span> <span class="keywordtype">char</span> *);
|
|
285
|
-
<a name="l00260"></a>00260 <span class="keywordflow">if</span> (arg == NULL) {
|
|
286
|
-
<a name="l00261"></a>00261 <span class="keywordflow">break</span>;
|
|
287
|
-
<a name="l00262"></a>00262 } <span class="keywordflow">else</span> {
|
|
288
|
-
<a name="l00263"></a>00263 args.push_back(arg);
|
|
289
|
-
<a name="l00264"></a>00264 }
|
|
290
|
-
<a name="l00265"></a>00265 }
|
|
291
|
-
<a name="l00266"></a>00266 <a class="code" href="classPassenger_1_1MessageChannel.html#a150f68bc47e060dcc6ca35bee047914d" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(args);
|
|
292
|
-
<a name="l00267"></a>00267 }
|
|
293
|
-
<a name="l00268"></a>00268 <span class="comment"></span>
|
|
294
|
-
<a name="l00269"></a>00269 <span class="comment"> /**</span>
|
|
295
|
-
<a name="l00270"></a>00270 <span class="comment"> * Send an array message, which consists of the given strings, over the underlying</span>
|
|
296
|
-
<a name="l00271"></a>00271 <span class="comment"> * file descriptor.</span>
|
|
297
|
-
<a name="l00272"></a>00272 <span class="comment"> *</span>
|
|
298
|
-
<a name="l00273"></a>00273 <span class="comment"> * @param name The first element of the message to send.</span>
|
|
299
|
-
<a name="l00274"></a>00274 <span class="comment"> * @param ... Other elements of the message. These *must* be strings, i.e. of type char*.</span>
|
|
300
|
-
<a name="l00275"></a>00275 <span class="comment"> * It is also required to terminate this list with a NULL.</span>
|
|
301
|
-
<a name="l00276"></a>00276 <span class="comment"> * @throws SystemException An error occured while writing the data to the file descriptor.</span>
|
|
302
|
-
<a name="l00277"></a>00277 <span class="comment"> * @throws boost::thread_interrupted</span>
|
|
303
|
-
<a name="l00278"></a>00278 <span class="comment"> * @pre None of the message elements may contain a NUL character (<tt>'\\0'</tt>).</span>
|
|
304
|
-
<a name="l00279"></a>00279 <span class="comment"> * @see read(), write(const list<string> &)</span>
|
|
305
|
-
<a name="l00280"></a>00280 <span class="comment"> */</span>
|
|
306
|
-
<a name="l00281"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a12cce3364023eacbe4fe09006cf3d38d">00281</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a12cce3364023eacbe4fe09006cf3d38d" title="Send an array message, which consists of the given strings, over the underlying file...">write</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, ...) {
|
|
307
|
-
<a name="l00282"></a>00282 va_list ap;
|
|
308
|
-
<a name="l00283"></a>00283 va_start(ap, name);
|
|
309
|
-
<a name="l00284"></a>00284 <span class="keywordflow">try</span> {
|
|
310
|
-
<a name="l00285"></a>00285 <a class="code" href="classPassenger_1_1MessageChannel.html#a150f68bc47e060dcc6ca35bee047914d" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(name, ap);
|
|
311
|
-
<a name="l00286"></a>00286 va_end(ap);
|
|
312
|
-
<a name="l00287"></a>00287 } <span class="keywordflow">catch</span> (...) {
|
|
313
|
-
<a name="l00288"></a>00288 va_end(ap);
|
|
314
|
-
<a name="l00289"></a>00289 <span class="keywordflow">throw</span>;
|
|
315
|
-
<a name="l00290"></a>00290 }
|
|
316
|
-
<a name="l00291"></a>00291 }
|
|
317
|
-
<a name="l00292"></a>00292 <span class="comment"></span>
|
|
318
|
-
<a name="l00293"></a>00293 <span class="comment"> /**</span>
|
|
319
|
-
<a name="l00294"></a>00294 <span class="comment"> * Write a 32-bit big-endian unsigned integer to the underlying file descriptor.</span>
|
|
320
|
-
<a name="l00295"></a>00295 <span class="comment"> *</span>
|
|
321
|
-
<a name="l00296"></a>00296 <span class="comment"> * @throws SystemException An error occurred while writing the data to the file descriptor.</span>
|
|
322
|
-
<a name="l00297"></a>00297 <span class="comment"> * @throws boost::thread_interrupted</span>
|
|
323
|
-
<a name="l00298"></a>00298 <span class="comment"> */</span>
|
|
324
|
-
<a name="l00299"></a><a class="code" href="classPassenger_1_1MessageChannel.html#abf02c51a74477650de8d5d5db661063b">00299</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#abf02c51a74477650de8d5d5db661063b" title="Write a 32-bit big-endian unsigned integer to the underlying file descriptor.">writeUint32</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> value) {
|
|
325
|
-
<a name="l00300"></a>00300 uint32_t l = htonl(value);
|
|
326
|
-
<a name="l00301"></a>00301 writeExact(fd, &l, <span class="keyword">sizeof</span>(uint32_t));
|
|
327
|
-
<a name="l00302"></a>00302 }
|
|
328
|
-
<a name="l00303"></a>00303 <span class="comment"></span>
|
|
329
|
-
<a name="l00304"></a>00304 <span class="comment"> /**</span>
|
|
330
|
-
<a name="l00305"></a>00305 <span class="comment"> * Write a scalar message to the underlying file descriptor.</span>
|
|
331
|
-
<a name="l00306"></a>00306 <span class="comment"> *</span>
|
|
332
|
-
<a name="l00307"></a>00307 <span class="comment"> * @note Security guarantee: this method will not copy the data in memory,</span>
|
|
333
|
-
<a name="l00308"></a>00308 <span class="comment"> * so it's safe to use this method to write passwords to the underlying</span>
|
|
334
|
-
<a name="l00309"></a>00309 <span class="comment"> * file descriptor.</span>
|
|
335
|
-
<a name="l00310"></a>00310 <span class="comment"> *</span>
|
|
336
|
-
<a name="l00311"></a>00311 <span class="comment"> * @param str The scalar message's content.</span>
|
|
337
|
-
<a name="l00312"></a>00312 <span class="comment"> * @throws SystemException An error occured while writing the data to the file descriptor.</span>
|
|
338
|
-
<a name="l00313"></a>00313 <span class="comment"> * @throws boost::thread_interrupted</span>
|
|
339
|
-
<a name="l00314"></a>00314 <span class="comment"> * @see readScalar(), writeScalar(const char *, unsigned int)</span>
|
|
340
|
-
<a name="l00315"></a>00315 <span class="comment"> */</span>
|
|
341
|
-
<a name="l00316"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a44e01a783c48abadeea0d915b9893bfb">00316</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a44e01a783c48abadeea0d915b9893bfb" title="Write a scalar message to the underlying file descriptor.">writeScalar</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &str) {
|
|
342
|
-
<a name="l00317"></a>00317 <a class="code" href="classPassenger_1_1MessageChannel.html#a44e01a783c48abadeea0d915b9893bfb" title="Write a scalar message to the underlying file descriptor.">writeScalar</a>(str.c_str(), str.size());
|
|
343
|
-
<a name="l00318"></a>00318 }
|
|
344
|
-
<a name="l00319"></a>00319 <span class="comment"></span>
|
|
345
|
-
<a name="l00320"></a>00320 <span class="comment"> /**</span>
|
|
346
|
-
<a name="l00321"></a>00321 <span class="comment"> * Write a scalar message to the underlying file descriptor.</span>
|
|
347
|
-
<a name="l00322"></a>00322 <span class="comment"> *</span>
|
|
348
|
-
<a name="l00323"></a>00323 <span class="comment"> * @note Security guarantee: this method will not copy the data in memory,</span>
|
|
349
|
-
<a name="l00324"></a>00324 <span class="comment"> * so it's safe to use this method to write passwords to the underlying</span>
|
|
350
|
-
<a name="l00325"></a>00325 <span class="comment"> * file descriptor.</span>
|
|
351
|
-
<a name="l00326"></a>00326 <span class="comment"> *</span>
|
|
352
|
-
<a name="l00327"></a>00327 <span class="comment"> * @param data The scalar message's content.</span>
|
|
353
|
-
<a name="l00328"></a>00328 <span class="comment"> * @param size The number of bytes in <tt>data</tt>.</span>
|
|
354
|
-
<a name="l00329"></a>00329 <span class="comment"> * @pre <tt>data != NULL</tt></span>
|
|
355
|
-
<a name="l00330"></a>00330 <span class="comment"> * @throws SystemException An error occured while writing the data to the file descriptor.</span>
|
|
356
|
-
<a name="l00331"></a>00331 <span class="comment"> * @throws boost::thread_interrupted</span>
|
|
357
|
-
<a name="l00332"></a>00332 <span class="comment"> * @see readScalar(), writeScalar(const string &)</span>
|
|
358
|
-
<a name="l00333"></a>00333 <span class="comment"> */</span>
|
|
359
|
-
<a name="l00334"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a80977020ef895f3ea790c5d28a333dda">00334</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a80977020ef895f3ea790c5d28a333dda" title="Write a scalar message to the underlying file descriptor.">writeScalar</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *data, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size) {
|
|
360
|
-
<a name="l00335"></a>00335 <a class="code" href="classPassenger_1_1MessageChannel.html#abf02c51a74477650de8d5d5db661063b" title="Write a 32-bit big-endian unsigned integer to the underlying file descriptor.">writeUint32</a>(size);
|
|
361
|
-
<a name="l00336"></a>00336 writeExact(fd, data, size);
|
|
362
|
-
<a name="l00337"></a>00337 }
|
|
363
|
-
<a name="l00338"></a>00338 <span class="comment"></span>
|
|
364
|
-
<a name="l00339"></a>00339 <span class="comment"> /**</span>
|
|
365
|
-
<a name="l00340"></a>00340 <span class="comment"> * Pass a file descriptor. This only works if the underlying file</span>
|
|
366
|
-
<a name="l00341"></a>00341 <span class="comment"> * descriptor is a Unix socket.</span>
|
|
367
|
-
<a name="l00342"></a>00342 <span class="comment"> *</span>
|
|
368
|
-
<a name="l00343"></a>00343 <span class="comment"> * @param fileDescriptor The file descriptor to pass.</span>
|
|
369
|
-
<a name="l00344"></a>00344 <span class="comment"> * @param negotiate See Ruby's MessageChannel#send_io method's comments.</span>
|
|
370
|
-
<a name="l00345"></a>00345 <span class="comment"> * @throws SystemException Something went wrong during file descriptor passing.</span>
|
|
371
|
-
<a name="l00346"></a>00346 <span class="comment"> * @throws boost::thread_interrupted</span>
|
|
372
|
-
<a name="l00347"></a>00347 <span class="comment"> * @pre <tt>fileDescriptor >= 0</tt></span>
|
|
373
|
-
<a name="l00348"></a>00348 <span class="comment"> * @see readFileDescriptor()</span>
|
|
374
|
-
<a name="l00349"></a>00349 <span class="comment"> */</span>
|
|
375
|
-
<a name="l00350"></a><a class="code" href="classPassenger_1_1MessageChannel.html#ae0c558e07dcc91900016773b2bec38d8">00350</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#ae0c558e07dcc91900016773b2bec38d8" title="Pass a file descriptor.">writeFileDescriptor</a>(<span class="keywordtype">int</span> fileDescriptor, <span class="keywordtype">bool</span> negotiate = <span class="keyword">true</span>) {
|
|
376
|
-
<a name="l00351"></a>00351 <span class="comment">// See message_channel.rb for more info about negotiation.</span>
|
|
377
|
-
<a name="l00352"></a>00352 <span class="keywordflow">if</span> (negotiate) {
|
|
378
|
-
<a name="l00353"></a>00353 vector<string> args;
|
|
379
|
-
<a name="l00354"></a>00354
|
|
380
|
-
<a name="l00355"></a>00355 <span class="keywordflow">if</span> (!<a class="code" href="classPassenger_1_1MessageChannel.html#a129659b60d1a663337873d2af944431e" title="Read an array message from the underlying file descriptor.">read</a>(args)) {
|
|
381
|
-
<a name="l00356"></a>00356 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(<span class="stringliteral">"Unexpected end of stream encountered while pre-negotiating a file descriptor"</span>);
|
|
382
|
-
<a name="l00357"></a>00357 } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (args.size() != 1 || args[0] != <span class="stringliteral">"pass IO"</span>) {
|
|
383
|
-
<a name="l00358"></a>00358 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(<span class="stringliteral">"FD passing pre-negotiation message expected."</span>);
|
|
384
|
-
<a name="l00359"></a>00359 }
|
|
385
|
-
<a name="l00360"></a>00360 }
|
|
386
|
-
<a name="l00361"></a>00361
|
|
387
|
-
<a name="l00362"></a>00362 <span class="keyword">struct </span>msghdr msg;
|
|
388
|
-
<a name="l00363"></a>00363 <span class="keyword">struct </span>iovec vec;
|
|
389
|
-
<a name="l00364"></a>00364 <span class="keywordtype">char</span> dummy[1];
|
|
390
|
-
<a name="l00365"></a>00365 <span class="preprocessor"> #if defined(__APPLE__) || defined(__SOLARIS__) || defined(__arm__)</span>
|
|
391
|
-
<a name="l00366"></a>00366 <span class="preprocessor"></span> <span class="keyword">struct </span>{
|
|
392
|
-
<a name="l00367"></a>00367 <span class="keyword">struct </span>cmsghdr header;
|
|
393
|
-
<a name="l00368"></a>00368 <span class="keywordtype">int</span> fd;
|
|
394
|
-
<a name="l00369"></a>00369 } control_data;
|
|
395
|
-
<a name="l00370"></a>00370 <span class="preprocessor"> #else</span>
|
|
396
|
-
<a name="l00371"></a>00371 <span class="preprocessor"></span> <span class="keywordtype">char</span> control_data[CMSG_SPACE(<span class="keyword">sizeof</span>(<span class="keywordtype">int</span>))];
|
|
397
|
-
<a name="l00372"></a>00372 <span class="preprocessor"> #endif</span>
|
|
398
|
-
<a name="l00373"></a>00373 <span class="preprocessor"></span> <span class="keyword">struct </span>cmsghdr *control_header;
|
|
399
|
-
<a name="l00374"></a>00374 <span class="keywordtype">int</span> ret;
|
|
400
|
-
<a name="l00375"></a>00375
|
|
401
|
-
<a name="l00376"></a>00376 msg.msg_name = NULL;
|
|
402
|
-
<a name="l00377"></a>00377 msg.msg_namelen = 0;
|
|
403
|
-
<a name="l00378"></a>00378
|
|
404
|
-
<a name="l00379"></a>00379 <span class="comment">/* Linux and Solaris require msg_iov to be non-NULL. */</span>
|
|
405
|
-
<a name="l00380"></a>00380 dummy[0] = <span class="charliteral">'\0'</span>;
|
|
406
|
-
<a name="l00381"></a>00381 vec.iov_base = dummy;
|
|
407
|
-
<a name="l00382"></a>00382 vec.iov_len = <span class="keyword">sizeof</span>(dummy);
|
|
408
|
-
<a name="l00383"></a>00383 msg.msg_iov = &vec;
|
|
409
|
-
<a name="l00384"></a>00384 msg.msg_iovlen = 1;
|
|
410
|
-
<a name="l00385"></a>00385
|
|
411
|
-
<a name="l00386"></a>00386 msg.msg_control = (caddr_t) &control_data;
|
|
412
|
-
<a name="l00387"></a>00387 msg.msg_controllen = <span class="keyword">sizeof</span>(control_data);
|
|
413
|
-
<a name="l00388"></a>00388 msg.msg_flags = 0;
|
|
414
|
-
<a name="l00389"></a>00389
|
|
415
|
-
<a name="l00390"></a>00390 control_header = CMSG_FIRSTHDR(&msg);
|
|
416
|
-
<a name="l00391"></a>00391 control_header->cmsg_level = SOL_SOCKET;
|
|
417
|
-
<a name="l00392"></a>00392 control_header->cmsg_type = SCM_RIGHTS;
|
|
418
|
-
<a name="l00393"></a>00393 <span class="preprocessor"> #if defined(__APPLE__) || defined(__SOLARIS__) || defined(__arm__)</span>
|
|
419
|
-
<a name="l00394"></a>00394 <span class="preprocessor"></span> control_header->cmsg_len = <span class="keyword">sizeof</span>(control_data);
|
|
420
|
-
<a name="l00395"></a>00395 control_data.fd = fileDescriptor;
|
|
421
|
-
<a name="l00396"></a>00396 <span class="preprocessor"> #else</span>
|
|
422
|
-
<a name="l00397"></a>00397 <span class="preprocessor"></span> control_header->cmsg_len = CMSG_LEN(<span class="keyword">sizeof</span>(<span class="keywordtype">int</span>));
|
|
423
|
-
<a name="l00398"></a>00398 memcpy(CMSG_DATA(control_header), &fileDescriptor, <span class="keyword">sizeof</span>(<span class="keywordtype">int</span>));
|
|
424
|
-
<a name="l00399"></a>00399 <span class="preprocessor"> #endif</span>
|
|
425
|
-
<a name="l00400"></a>00400 <span class="preprocessor"></span>
|
|
426
|
-
<a name="l00401"></a>00401 ret = syscalls::sendmsg(fd, &msg, 0);
|
|
427
|
-
<a name="l00402"></a>00402 <span class="keywordflow">if</span> (ret == -1) {
|
|
428
|
-
<a name="l00403"></a>00403 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">"Cannot send file descriptor with sendmsg()"</span>, errno);
|
|
429
|
-
<a name="l00404"></a>00404 }
|
|
430
|
-
<a name="l00405"></a>00405
|
|
431
|
-
<a name="l00406"></a>00406 <span class="keywordflow">if</span> (negotiate) {
|
|
432
|
-
<a name="l00407"></a>00407 vector<string> args;
|
|
433
|
-
<a name="l00408"></a>00408
|
|
434
|
-
<a name="l00409"></a>00409 <span class="keywordflow">if</span> (!<a class="code" href="classPassenger_1_1MessageChannel.html#a129659b60d1a663337873d2af944431e" title="Read an array message from the underlying file descriptor.">read</a>(args)) {
|
|
435
|
-
<a name="l00410"></a>00410 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(<span class="stringliteral">"Unexpected end of stream encountered while post-negotiating a file descriptor"</span>);
|
|
436
|
-
<a name="l00411"></a>00411 } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (args.size() != 1 || args[0] != <span class="stringliteral">"got IO"</span>) {
|
|
437
|
-
<a name="l00412"></a>00412 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(<span class="stringliteral">"FD passing post-negotiation message expected."</span>);
|
|
438
|
-
<a name="l00413"></a>00413 }
|
|
439
|
-
<a name="l00414"></a>00414 }
|
|
440
|
-
<a name="l00415"></a>00415 }
|
|
441
|
-
<a name="l00416"></a>00416 <span class="comment"></span>
|
|
442
|
-
<a name="l00417"></a>00417 <span class="comment"> /**</span>
|
|
443
|
-
<a name="l00418"></a>00418 <span class="comment"> * Read an array message from the underlying file descriptor.</span>
|
|
444
|
-
<a name="l00419"></a>00419 <span class="comment"> *</span>
|
|
445
|
-
<a name="l00420"></a>00420 <span class="comment"> * @param args The message will be put in this variable.</span>
|
|
446
|
-
<a name="l00421"></a>00421 <span class="comment"> * @return Whether end-of-file has been reached. If so, then the contents</span>
|
|
447
|
-
<a name="l00422"></a>00422 <span class="comment"> * of <tt>args</tt> will be undefined.</span>
|
|
448
|
-
<a name="l00423"></a>00423 <span class="comment"> * @throws SystemException If an error occured while receiving the message.</span>
|
|
449
|
-
<a name="l00424"></a>00424 <span class="comment"> * @throws boost::thread_interrupted</span>
|
|
450
|
-
<a name="l00425"></a>00425 <span class="comment"> * @see write()</span>
|
|
451
|
-
<a name="l00426"></a>00426 <span class="comment"> */</span>
|
|
452
|
-
<a name="l00427"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a129659b60d1a663337873d2af944431e">00427</a> <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a129659b60d1a663337873d2af944431e" title="Read an array message from the underlying file descriptor.">read</a>(vector<string> &args) {
|
|
453
|
-
<a name="l00428"></a>00428 uint16_t size;
|
|
454
|
-
<a name="l00429"></a>00429 <span class="keywordtype">int</span> ret;
|
|
455
|
-
<a name="l00430"></a>00430 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> alreadyRead = 0;
|
|
456
|
-
<a name="l00431"></a>00431
|
|
457
|
-
<a name="l00432"></a>00432 <span class="keywordflow">do</span> {
|
|
458
|
-
<a name="l00433"></a>00433 ret = <a class="code" href="classPassenger_1_1MessageChannel.html#a129659b60d1a663337873d2af944431e" title="Read an array message from the underlying file descriptor.">syscalls::read</a>(fd, (<span class="keywordtype">char</span> *) &size + alreadyRead, <span class="keyword">sizeof</span>(size) - alreadyRead);
|
|
459
|
-
<a name="l00434"></a>00434 <span class="keywordflow">if</span> (ret == -1) {
|
|
460
|
-
<a name="l00435"></a>00435 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">"read() failed"</span>, errno);
|
|
461
|
-
<a name="l00436"></a>00436 } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (ret == 0) {
|
|
462
|
-
<a name="l00437"></a>00437 <span class="keywordflow">return</span> <span class="keyword">false</span>;
|
|
463
|
-
<a name="l00438"></a>00438 }
|
|
464
|
-
<a name="l00439"></a>00439 alreadyRead += ret;
|
|
465
|
-
<a name="l00440"></a>00440 } <span class="keywordflow">while</span> (alreadyRead < <span class="keyword">sizeof</span>(size));
|
|
466
|
-
<a name="l00441"></a>00441 size = ntohs(size);
|
|
467
|
-
<a name="l00442"></a>00442
|
|
468
|
-
<a name="l00443"></a>00443 <span class="keywordtype">string</span> buffer;
|
|
469
|
-
<a name="l00444"></a>00444 args.clear();
|
|
470
|
-
<a name="l00445"></a>00445 buffer.reserve(size);
|
|
471
|
-
<a name="l00446"></a>00446 <span class="keywordflow">while</span> (buffer.size() < size) {
|
|
472
|
-
<a name="l00447"></a>00447 <span class="keywordtype">char</span> tmp[1024 * 8];
|
|
473
|
-
<a name="l00448"></a>00448 ret = <a class="code" href="classPassenger_1_1MessageChannel.html#a129659b60d1a663337873d2af944431e" title="Read an array message from the underlying file descriptor.">syscalls::read</a>(fd, tmp, min(size - buffer.size(), <span class="keyword">sizeof</span>(tmp)));
|
|
474
|
-
<a name="l00449"></a>00449 <span class="keywordflow">if</span> (ret == -1) {
|
|
475
|
-
<a name="l00450"></a>00450 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">"read() failed"</span>, errno);
|
|
476
|
-
<a name="l00451"></a>00451 } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (ret == 0) {
|
|
477
|
-
<a name="l00452"></a>00452 <span class="keywordflow">return</span> <span class="keyword">false</span>;
|
|
478
|
-
<a name="l00453"></a>00453 }
|
|
479
|
-
<a name="l00454"></a>00454 buffer.append(tmp, ret);
|
|
480
|
-
<a name="l00455"></a>00455 }
|
|
481
|
-
<a name="l00456"></a>00456
|
|
482
|
-
<a name="l00457"></a>00457 <span class="keywordflow">if</span> (!buffer.empty()) {
|
|
483
|
-
<a name="l00458"></a>00458 string::size_type start = 0, pos;
|
|
484
|
-
<a name="l00459"></a>00459 <span class="keyword">const</span> <span class="keywordtype">string</span> &const_buffer(buffer);
|
|
485
|
-
<a name="l00460"></a>00460 <span class="keywordflow">while</span> ((pos = const_buffer.find(<span class="charliteral">'\0'</span>, start)) != string::npos) {
|
|
486
|
-
<a name="l00461"></a>00461 args.push_back(const_buffer.substr(start, pos - start));
|
|
487
|
-
<a name="l00462"></a>00462 start = pos + 1;
|
|
488
|
-
<a name="l00463"></a>00463 }
|
|
489
|
-
<a name="l00464"></a>00464 }
|
|
490
|
-
<a name="l00465"></a>00465 <span class="keywordflow">return</span> <span class="keyword">true</span>;
|
|
491
|
-
<a name="l00466"></a>00466 }
|
|
492
|
-
<a name="l00467"></a>00467 <span class="comment"></span>
|
|
493
|
-
<a name="l00468"></a>00468 <span class="comment"> /**</span>
|
|
494
|
-
<a name="l00469"></a>00469 <span class="comment"> * Read a 32-bit big-endian unsigned integer from the underlying file descriptor.</span>
|
|
495
|
-
<a name="l00470"></a>00470 <span class="comment"> *</span>
|
|
496
|
-
<a name="l00471"></a>00471 <span class="comment"> * @param value Upon success, the read value will be stored in here.</span>
|
|
497
|
-
<a name="l00472"></a>00472 <span class="comment"> * @param timeout A pointer to an integer, representing the maximum number of</span>
|
|
498
|
-
<a name="l00473"></a>00473 <span class="comment"> * milliseconds to spend on reading the entire integer.</span>
|
|
499
|
-
<a name="l00474"></a>00474 <span class="comment"> * A TimeoutException will be thrown if the timeout expires.</span>
|
|
500
|
-
<a name="l00475"></a>00475 <span class="comment"> * If no exception is thrown, the the amount of time spent on waiting</span>
|
|
501
|
-
<a name="l00476"></a>00476 <span class="comment"> * will be deducted from <tt>*timeout</tt>.</span>
|
|
502
|
-
<a name="l00477"></a>00477 <span class="comment"> * Pass NULL if you do not want to enforce any time limits.</span>
|
|
503
|
-
<a name="l00478"></a>00478 <span class="comment"> * @return True if a value was read, false if EOF was reached before all data can be</span>
|
|
504
|
-
<a name="l00479"></a>00479 <span class="comment"> * read.</span>
|
|
505
|
-
<a name="l00480"></a>00480 <span class="comment"> * @throws SystemException An error occurred while reading data from the file descriptor.</span>
|
|
506
|
-
<a name="l00481"></a>00481 <span class="comment"> * @throws boost::thread_interrupted</span>
|
|
507
|
-
<a name="l00482"></a>00482 <span class="comment"> */</span>
|
|
508
|
-
<a name="l00483"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a7b0c67852ea8ab455af75b1037c7f8b6">00483</a> <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a7b0c67852ea8ab455af75b1037c7f8b6" title="Read a 32-bit big-endian unsigned integer from the underlying file descriptor.">readUint32</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> &value, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> *timeout = NULL) {
|
|
509
|
-
<a name="l00484"></a>00484 uint32_t temp;
|
|
510
|
-
<a name="l00485"></a>00485
|
|
511
|
-
<a name="l00486"></a>00486 <span class="keywordflow">if</span> (!<a class="code" href="classPassenger_1_1MessageChannel.html#ab471dc1888f030e20ed23068a160ec2a" title="Read exactly size bytes of data from the underlying file descriptor, and put the...">readRaw</a>(&temp, <span class="keyword">sizeof</span>(uint32_t), timeout)) {
|
|
512
|
-
<a name="l00487"></a>00487 <span class="keywordflow">return</span> <span class="keyword">false</span>;
|
|
513
|
-
<a name="l00488"></a>00488 } <span class="keywordflow">else</span> {
|
|
514
|
-
<a name="l00489"></a>00489 value = ntohl(temp);
|
|
515
|
-
<a name="l00490"></a>00490 <span class="keywordflow">return</span> <span class="keyword">true</span>;
|
|
516
|
-
<a name="l00491"></a>00491 }
|
|
517
|
-
<a name="l00492"></a>00492 }
|
|
518
|
-
<a name="l00493"></a>00493 <span class="comment"></span>
|
|
519
|
-
<a name="l00494"></a>00494 <span class="comment"> /**</span>
|
|
520
|
-
<a name="l00495"></a>00495 <span class="comment"> * Read a scalar message from the underlying file descriptor.</span>
|
|
521
|
-
<a name="l00496"></a>00496 <span class="comment"> *</span>
|
|
522
|
-
<a name="l00497"></a>00497 <span class="comment"> * @param output The message will be put in here.</span>
|
|
523
|
-
<a name="l00498"></a>00498 <span class="comment"> * @param maxSize The maximum number of bytes that may be read. If the</span>
|
|
524
|
-
<a name="l00499"></a>00499 <span class="comment"> * scalar to read is larger than this, then a SecurityException</span>
|
|
525
|
-
<a name="l00500"></a>00500 <span class="comment"> * will be thrown. Set to 0 for no size limit.</span>
|
|
526
|
-
<a name="l00501"></a>00501 <span class="comment"> * @param timeout A pointer to an integer, representing the maximum number of</span>
|
|
527
|
-
<a name="l00502"></a>00502 <span class="comment"> * milliseconds to spend on reading the entire scalar.</span>
|
|
528
|
-
<a name="l00503"></a>00503 <span class="comment"> * A TimeoutException will be thrown if unable to read the entire</span>
|
|
529
|
-
<a name="l00504"></a>00504 <span class="comment"> * scalar within this time period.</span>
|
|
530
|
-
<a name="l00505"></a>00505 <span class="comment"> * If no exception is thrown, the the amount of time spent on waiting</span>
|
|
531
|
-
<a name="l00506"></a>00506 <span class="comment"> * will be deducted from <tt>*timeout</tt>.</span>
|
|
532
|
-
<a name="l00507"></a>00507 <span class="comment"> * Pass NULL if you do not want to enforce any time limits.</span>
|
|
533
|
-
<a name="l00508"></a>00508 <span class="comment"> * @returns Whether end-of-file was reached during reading.</span>
|
|
534
|
-
<a name="l00509"></a>00509 <span class="comment"> * @throws SystemException An error occured while reading data from the file descriptor.</span>
|
|
535
|
-
<a name="l00510"></a>00510 <span class="comment"> * @throws SecurityException There is more data to read than allowed by maxSize.</span>
|
|
536
|
-
<a name="l00511"></a>00511 <span class="comment"> * @throws TimeoutException Unable to read the entire scalar within <tt>timeout</tt></span>
|
|
537
|
-
<a name="l00512"></a>00512 <span class="comment"> * milliseconds.</span>
|
|
538
|
-
<a name="l00513"></a>00513 <span class="comment"> * @throws boost::thread_interrupted</span>
|
|
539
|
-
<a name="l00514"></a>00514 <span class="comment"> * @see writeScalar()</span>
|
|
540
|
-
<a name="l00515"></a>00515 <span class="comment"> */</span>
|
|
541
|
-
<a name="l00516"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a1f3cf672b566166ed920c2bba4d19604">00516</a> <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a1f3cf672b566166ed920c2bba4d19604" title="Read a scalar message from the underlying file descriptor.">readScalar</a>(<span class="keywordtype">string</span> &output, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> maxSize = 0, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> *timeout = NULL) {
|
|
542
|
-
<a name="l00517"></a>00517 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size;
|
|
543
|
-
<a name="l00518"></a>00518 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> remaining;
|
|
544
|
-
<a name="l00519"></a>00519
|
|
545
|
-
<a name="l00520"></a>00520 <span class="keywordflow">if</span> (!<a class="code" href="classPassenger_1_1MessageChannel.html#a7b0c67852ea8ab455af75b1037c7f8b6" title="Read a 32-bit big-endian unsigned integer from the underlying file descriptor.">readUint32</a>(size, timeout)) {
|
|
546
|
-
<a name="l00521"></a>00521 <span class="keywordflow">return</span> <span class="keyword">false</span>;
|
|
547
|
-
<a name="l00522"></a>00522 }
|
|
548
|
-
<a name="l00523"></a>00523
|
|
549
|
-
<a name="l00524"></a>00524 <span class="keywordflow">if</span> (maxSize != 0 && size > maxSize) {
|
|
550
|
-
<a name="l00525"></a>00525 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SecurityException.html" title="Represents some kind of security error.">SecurityException</a>(<span class="stringliteral">"There is more data available than is allowed by the size limit."</span>);
|
|
551
|
-
<a name="l00526"></a>00526 }
|
|
552
|
-
<a name="l00527"></a>00527
|
|
553
|
-
<a name="l00528"></a>00528 output.clear();
|
|
554
|
-
<a name="l00529"></a>00529 output.reserve(size);
|
|
555
|
-
<a name="l00530"></a>00530 remaining = size;
|
|
556
|
-
<a name="l00531"></a>00531 <span class="keywordflow">if</span> (OXT_LIKELY(remaining > 0)) {
|
|
557
|
-
<a name="l00532"></a>00532 <span class="keywordtype">char</span> buf[1024 * 32];
|
|
558
|
-
<a name="l00533"></a>00533 <span class="comment">// Wipe the buffer when we're done; it might contain sensitive data.</span>
|
|
559
|
-
<a name="l00534"></a>00534 MemZeroGuard g(buf, <span class="keyword">sizeof</span>(buf));
|
|
560
|
-
<a name="l00535"></a>00535
|
|
561
|
-
<a name="l00536"></a>00536 <span class="keywordflow">while</span> (remaining > 0) {
|
|
562
|
-
<a name="l00537"></a>00537 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> blockSize = min((<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>) <span class="keyword">sizeof</span>(buf), remaining);
|
|
563
|
-
<a name="l00538"></a>00538
|
|
564
|
-
<a name="l00539"></a>00539 <span class="keywordflow">if</span> (!<a class="code" href="classPassenger_1_1MessageChannel.html#ab471dc1888f030e20ed23068a160ec2a" title="Read exactly size bytes of data from the underlying file descriptor, and put the...">readRaw</a>(buf, blockSize, timeout)) {
|
|
565
|
-
<a name="l00540"></a>00540 <span class="keywordflow">return</span> <span class="keyword">false</span>;
|
|
566
|
-
<a name="l00541"></a>00541 }
|
|
567
|
-
<a name="l00542"></a>00542 output.append(buf, blockSize);
|
|
568
|
-
<a name="l00543"></a>00543 remaining -= blockSize;
|
|
569
|
-
<a name="l00544"></a>00544 }
|
|
570
|
-
<a name="l00545"></a>00545 }
|
|
571
|
-
<a name="l00546"></a>00546 <span class="keywordflow">return</span> <span class="keyword">true</span>;
|
|
572
|
-
<a name="l00547"></a>00547 }
|
|
573
|
-
<a name="l00548"></a>00548 <span class="comment"></span>
|
|
574
|
-
<a name="l00549"></a>00549 <span class="comment"> /**</span>
|
|
575
|
-
<a name="l00550"></a>00550 <span class="comment"> * Read exactly <tt>size</tt> bytes of data from the underlying file descriptor,</span>
|
|
576
|
-
<a name="l00551"></a>00551 <span class="comment"> * and put the result in <tt>buf</tt>. If end-of-file has been reached, or if</span>
|
|
577
|
-
<a name="l00552"></a>00552 <span class="comment"> * end-of-file was encountered before <tt>size</tt> bytes have been read, then</span>
|
|
578
|
-
<a name="l00553"></a>00553 <span class="comment"> * <tt>false</tt> will be returned. Otherwise (i.e. if the read was successful),</span>
|
|
579
|
-
<a name="l00554"></a>00554 <span class="comment"> * <tt>true</tt> will be returned.</span>
|
|
580
|
-
<a name="l00555"></a>00555 <span class="comment"> *</span>
|
|
581
|
-
<a name="l00556"></a>00556 <span class="comment"> * @param buf The buffer to place the read data in. This buffer must be at least</span>
|
|
582
|
-
<a name="l00557"></a>00557 <span class="comment"> * <tt>size</tt> bytes long.</span>
|
|
583
|
-
<a name="l00558"></a>00558 <span class="comment"> * @param size The number of bytes to read.</span>
|
|
584
|
-
<a name="l00559"></a>00559 <span class="comment"> * @param timeout A pointer to an integer, which specifies the maximum number of</span>
|
|
585
|
-
<a name="l00560"></a>00560 <span class="comment"> * milliseconds that may be spent on reading the <tt>size</tt> bytes</span>
|
|
586
|
-
<a name="l00561"></a>00561 <span class="comment"> * of data. If the timeout expired then TimeoutException will be</span>
|
|
587
|
-
<a name="l00562"></a>00562 <span class="comment"> * thrown.</span>
|
|
588
|
-
<a name="l00563"></a>00563 <span class="comment"> * If this function returns without throwing an exception, then the</span>
|
|
589
|
-
<a name="l00564"></a>00564 <span class="comment"> * total number of milliseconds spent on reading will be deducted</span>
|
|
590
|
-
<a name="l00565"></a>00565 <span class="comment"> * from <tt>timeout</tt>.</span>
|
|
591
|
-
<a name="l00566"></a>00566 <span class="comment"> * Pass NULL if you do not want to enforce a timeout.</span>
|
|
592
|
-
<a name="l00567"></a>00567 <span class="comment"> * @return Whether reading was successful or whether EOF was reached.</span>
|
|
593
|
-
<a name="l00568"></a>00568 <span class="comment"> * @pre buf != NULL</span>
|
|
594
|
-
<a name="l00569"></a>00569 <span class="comment"> * @throws SystemException Something went wrong during reading.</span>
|
|
595
|
-
<a name="l00570"></a>00570 <span class="comment"> * @throws TimeoutException Unable to read <tt>size</tt> bytes of data within</span>
|
|
596
|
-
<a name="l00571"></a>00571 <span class="comment"> * <tt>timeout</tt> milliseconds.</span>
|
|
597
|
-
<a name="l00572"></a>00572 <span class="comment"> * @throws boost::thread_interrupted</span>
|
|
598
|
-
<a name="l00573"></a>00573 <span class="comment"> */</span>
|
|
599
|
-
<a name="l00574"></a><a class="code" href="classPassenger_1_1MessageChannel.html#ab471dc1888f030e20ed23068a160ec2a">00574</a> <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1MessageChannel.html#ab471dc1888f030e20ed23068a160ec2a" title="Read exactly size bytes of data from the underlying file descriptor, and put the...">readRaw</a>(<span class="keywordtype">void</span> *buf, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> *timeout = NULL) {
|
|
600
|
-
<a name="l00575"></a>00575 <span class="keywordflow">if</span> (timeout != NULL) {
|
|
601
|
-
<a name="l00576"></a>00576 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> t = *timeout * 1000;
|
|
602
|
-
<a name="l00577"></a>00577 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> ret;
|
|
603
|
-
<a name="l00578"></a>00578 <span class="keywordflow">try</span> {
|
|
604
|
-
<a name="l00579"></a>00579 ret = Passenger::readExact(fd, buf, size, &t);
|
|
605
|
-
<a name="l00580"></a>00580 <span class="preprocessor"> #if defined(__NetBSD__) || defined(__OpenBSD__)</span>
|
|
606
|
-
<a name="l00581"></a>00581 <span class="preprocessor"></span> *timeout = llround((<span class="keywordtype">double</span>) t / 1000);
|
|
607
|
-
<a name="l00582"></a>00582 <span class="preprocessor"> #else</span>
|
|
608
|
-
<a name="l00583"></a>00583 <span class="preprocessor"></span> *timeout = llroundl((<span class="keywordtype">long</span> <span class="keywordtype">double</span>) t / 1000);
|
|
609
|
-
<a name="l00584"></a>00584 <span class="preprocessor"> #endif</span>
|
|
610
|
-
<a name="l00585"></a>00585 <span class="preprocessor"></span> <span class="keywordflow">return</span> ret == size;
|
|
611
|
-
<a name="l00586"></a>00586 } <span class="keywordflow">catch</span> (...) {
|
|
612
|
-
<a name="l00587"></a>00587 <span class="preprocessor"> #if defined(__NetBSD__) || defined(__OpenBSD__)</span>
|
|
613
|
-
<a name="l00588"></a>00588 <span class="preprocessor"></span> *timeout = llround((<span class="keywordtype">double</span>) t / 1000);
|
|
614
|
-
<a name="l00589"></a>00589 <span class="preprocessor"> #else</span>
|
|
615
|
-
<a name="l00590"></a>00590 <span class="preprocessor"></span> *timeout = llroundl((<span class="keywordtype">long</span> <span class="keywordtype">double</span>) t / 1000);
|
|
616
|
-
<a name="l00591"></a>00591 <span class="preprocessor"> #endif</span>
|
|
617
|
-
<a name="l00592"></a>00592 <span class="preprocessor"></span> <span class="keywordflow">throw</span>;
|
|
618
|
-
<a name="l00593"></a>00593 }
|
|
619
|
-
<a name="l00594"></a>00594 } <span class="keywordflow">else</span> {
|
|
620
|
-
<a name="l00595"></a>00595 <span class="keywordflow">return</span> Passenger::readExact(fd, buf, size) == size;
|
|
621
|
-
<a name="l00596"></a>00596 }
|
|
622
|
-
<a name="l00597"></a>00597 }
|
|
623
|
-
<a name="l00598"></a>00598 <span class="comment"></span>
|
|
624
|
-
<a name="l00599"></a>00599 <span class="comment"> /**</span>
|
|
625
|
-
<a name="l00600"></a>00600 <span class="comment"> * Receive a file descriptor, which had been passed over the underlying</span>
|
|
626
|
-
<a name="l00601"></a>00601 <span class="comment"> * file descriptor.</span>
|
|
627
|
-
<a name="l00602"></a>00602 <span class="comment"> *</span>
|
|
628
|
-
<a name="l00603"></a>00603 <span class="comment"> * @param negotiate See Ruby's MessageChannel#send_io method's comments.</span>
|
|
629
|
-
<a name="l00604"></a>00604 <span class="comment"> * @return The passed file descriptor.</span>
|
|
630
|
-
<a name="l00605"></a>00605 <span class="comment"> * @throws SystemException If something went wrong during the</span>
|
|
631
|
-
<a name="l00606"></a>00606 <span class="comment"> * receiving of a file descriptor. Perhaps the underlying</span>
|
|
632
|
-
<a name="l00607"></a>00607 <span class="comment"> * file descriptor isn't a Unix socket.</span>
|
|
633
|
-
<a name="l00608"></a>00608 <span class="comment"> * @throws IOException Whatever was received doesn't seem to be a</span>
|
|
634
|
-
<a name="l00609"></a>00609 <span class="comment"> * file descriptor.</span>
|
|
635
|
-
<a name="l00610"></a>00610 <span class="comment"> * @throws boost::thread_interrupted</span>
|
|
636
|
-
<a name="l00611"></a>00611 <span class="comment"> */</span>
|
|
637
|
-
<a name="l00612"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a1a28ba9d078f38f2831673092ac9dcbc">00612</a> <span class="keywordtype">int</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a1a28ba9d078f38f2831673092ac9dcbc" title="Receive a file descriptor, which had been passed over the underlying file descriptor...">readFileDescriptor</a>(<span class="keywordtype">bool</span> negotiate = <span class="keyword">true</span>) {
|
|
638
|
-
<a name="l00613"></a>00613 <span class="comment">// See message_channel.rb for more info about negotiation.</span>
|
|
639
|
-
<a name="l00614"></a>00614 <span class="keywordflow">if</span> (negotiate) {
|
|
640
|
-
<a name="l00615"></a>00615 <a class="code" href="classPassenger_1_1MessageChannel.html#a150f68bc47e060dcc6ca35bee047914d" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(<span class="stringliteral">"pass IO"</span>, NULL);
|
|
641
|
-
<a name="l00616"></a>00616 }
|
|
642
|
-
<a name="l00617"></a>00617
|
|
643
|
-
<a name="l00618"></a>00618 <span class="keyword">struct </span>msghdr msg;
|
|
644
|
-
<a name="l00619"></a>00619 <span class="keyword">struct </span>iovec vec;
|
|
645
|
-
<a name="l00620"></a>00620 <span class="keywordtype">char</span> dummy[1];
|
|
646
|
-
<a name="l00621"></a>00621 <span class="preprocessor"> #if defined(__APPLE__) || defined(__SOLARIS__) || defined(__arm__)</span>
|
|
647
|
-
<a name="l00622"></a>00622 <span class="preprocessor"></span> <span class="comment">// File descriptor passing macros (CMSG_*) seem to be broken</span>
|
|
648
|
-
<a name="l00623"></a>00623 <span class="comment">// on 64-bit MacOS X. This structure works around the problem.</span>
|
|
649
|
-
<a name="l00624"></a>00624 <span class="keyword">struct </span>{
|
|
650
|
-
<a name="l00625"></a>00625 <span class="keyword">struct </span>cmsghdr header;
|
|
651
|
-
<a name="l00626"></a>00626 <span class="keywordtype">int</span> fd;
|
|
652
|
-
<a name="l00627"></a>00627 } control_data;
|
|
653
|
-
<a name="l00628"></a>00628 <span class="preprocessor"> #define EXPECTED_CMSG_LEN sizeof(control_data)</span>
|
|
654
|
-
<a name="l00629"></a>00629 <span class="preprocessor"></span><span class="preprocessor"> #else</span>
|
|
655
|
-
<a name="l00630"></a>00630 <span class="preprocessor"></span> <span class="keywordtype">char</span> control_data[CMSG_SPACE(<span class="keyword">sizeof</span>(<span class="keywordtype">int</span>))];
|
|
656
|
-
<a name="l00631"></a>00631 <span class="preprocessor"> #define EXPECTED_CMSG_LEN CMSG_LEN(sizeof(int))</span>
|
|
657
|
-
<a name="l00632"></a>00632 <span class="preprocessor"></span><span class="preprocessor"> #endif</span>
|
|
658
|
-
<a name="l00633"></a>00633 <span class="preprocessor"></span> <span class="keyword">struct </span>cmsghdr *control_header;
|
|
659
|
-
<a name="l00634"></a>00634 <span class="keywordtype">int</span> ret;
|
|
660
|
-
<a name="l00635"></a>00635
|
|
661
|
-
<a name="l00636"></a>00636 msg.msg_name = NULL;
|
|
662
|
-
<a name="l00637"></a>00637 msg.msg_namelen = 0;
|
|
663
|
-
<a name="l00638"></a>00638
|
|
664
|
-
<a name="l00639"></a>00639 dummy[0] = <span class="charliteral">'\0'</span>;
|
|
665
|
-
<a name="l00640"></a>00640 vec.iov_base = dummy;
|
|
666
|
-
<a name="l00641"></a>00641 vec.iov_len = <span class="keyword">sizeof</span>(dummy);
|
|
667
|
-
<a name="l00642"></a>00642 msg.msg_iov = &vec;
|
|
668
|
-
<a name="l00643"></a>00643 msg.msg_iovlen = 1;
|
|
669
|
-
<a name="l00644"></a>00644
|
|
670
|
-
<a name="l00645"></a>00645 msg.msg_control = (caddr_t) &control_data;
|
|
671
|
-
<a name="l00646"></a>00646 msg.msg_controllen = <span class="keyword">sizeof</span>(control_data);
|
|
672
|
-
<a name="l00647"></a>00647 msg.msg_flags = 0;
|
|
673
|
-
<a name="l00648"></a>00648
|
|
674
|
-
<a name="l00649"></a>00649 ret = syscalls::recvmsg(fd, &msg, 0);
|
|
675
|
-
<a name="l00650"></a>00650 <span class="keywordflow">if</span> (ret == -1) {
|
|
676
|
-
<a name="l00651"></a>00651 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">"Cannot read file descriptor with recvmsg()"</span>, errno);
|
|
677
|
-
<a name="l00652"></a>00652 }
|
|
678
|
-
<a name="l00653"></a>00653
|
|
679
|
-
<a name="l00654"></a>00654 control_header = CMSG_FIRSTHDR(&msg);
|
|
680
|
-
<a name="l00655"></a>00655 <span class="keywordflow">if</span> (control_header == NULL) {
|
|
681
|
-
<a name="l00656"></a>00656 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(<span class="stringliteral">"No valid file descriptor received."</span>);
|
|
682
|
-
<a name="l00657"></a>00657 }
|
|
683
|
-
<a name="l00658"></a>00658 <span class="keywordflow">if</span> (control_header->cmsg_len != EXPECTED_CMSG_LEN
|
|
684
|
-
<a name="l00659"></a>00659 || control_header->cmsg_level != SOL_SOCKET
|
|
685
|
-
<a name="l00660"></a>00660 || control_header->cmsg_type != SCM_RIGHTS) {
|
|
686
|
-
<a name="l00661"></a>00661 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(<span class="stringliteral">"No valid file descriptor received."</span>);
|
|
687
|
-
<a name="l00662"></a>00662 }
|
|
688
|
-
<a name="l00663"></a>00663
|
|
689
|
-
<a name="l00664"></a>00664 <span class="preprocessor"> #if defined(__APPLE__) || defined(__SOLARIS__) || defined(__arm__)</span>
|
|
690
|
-
<a name="l00665"></a>00665 <span class="preprocessor"></span> <span class="keywordtype">int</span> fd = control_data.fd;
|
|
691
|
-
<a name="l00666"></a>00666 <span class="preprocessor"> #else</span>
|
|
692
|
-
<a name="l00667"></a>00667 <span class="preprocessor"></span> <span class="keywordtype">int</span> fd = *((<span class="keywordtype">int</span> *) CMSG_DATA(control_header));
|
|
693
|
-
<a name="l00668"></a>00668 <span class="preprocessor"> #endif</span>
|
|
694
|
-
<a name="l00669"></a>00669 <span class="preprocessor"></span>
|
|
695
|
-
<a name="l00670"></a>00670 <span class="keywordflow">if</span> (negotiate) {
|
|
696
|
-
<a name="l00671"></a>00671 <span class="keywordflow">try</span> {
|
|
697
|
-
<a name="l00672"></a>00672 <a class="code" href="classPassenger_1_1MessageChannel.html#a150f68bc47e060dcc6ca35bee047914d" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(<span class="stringliteral">"got IO"</span>, NULL);
|
|
698
|
-
<a name="l00673"></a>00673 } <span class="keywordflow">catch</span> (...) {
|
|
699
|
-
<a name="l00674"></a>00674 this_thread::disable_syscall_interruption dsi;
|
|
700
|
-
<a name="l00675"></a>00675 <a class="code" href="classPassenger_1_1MessageChannel.html#a06309e208fc5e10642a2e9bbe0f351eb" title="Close the underlying file descriptor.">syscalls::close</a>(fd);
|
|
701
|
-
<a name="l00676"></a>00676 <span class="keywordflow">throw</span>;
|
|
702
|
-
<a name="l00677"></a>00677 }
|
|
703
|
-
<a name="l00678"></a>00678 }
|
|
704
|
-
<a name="l00679"></a>00679
|
|
705
|
-
<a name="l00680"></a>00680 <span class="keywordflow">return</span> fd;
|
|
706
|
-
<a name="l00681"></a>00681 }
|
|
707
|
-
<a name="l00682"></a>00682 <span class="comment"></span>
|
|
708
|
-
<a name="l00683"></a>00683 <span class="comment"> /**</span>
|
|
709
|
-
<a name="l00684"></a>00684 <span class="comment"> * Set the timeout value for reading data from this channel.</span>
|
|
710
|
-
<a name="l00685"></a>00685 <span class="comment"> * If no data can be read within the timeout period, then a</span>
|
|
711
|
-
<a name="l00686"></a>00686 <span class="comment"> * SystemException will be thrown by one of the read methods,</span>
|
|
712
|
-
<a name="l00687"></a>00687 <span class="comment"> * with error code EAGAIN or EWOULDBLOCK.</span>
|
|
713
|
-
<a name="l00688"></a>00688 <span class="comment"> *</span>
|
|
714
|
-
<a name="l00689"></a>00689 <span class="comment"> * @param msec The timeout, in milliseconds. If 0 is given,</span>
|
|
715
|
-
<a name="l00690"></a>00690 <span class="comment"> * there will be no timeout.</span>
|
|
716
|
-
<a name="l00691"></a>00691 <span class="comment"> * @throws SystemException Cannot set the timeout.</span>
|
|
717
|
-
<a name="l00692"></a>00692 <span class="comment"> */</span>
|
|
718
|
-
<a name="l00693"></a><a class="code" href="classPassenger_1_1MessageChannel.html#aeb69bffbbb148c9bc8662e20b416c4e2">00693</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#aeb69bffbbb148c9bc8662e20b416c4e2" title="Set the timeout value for reading data from this channel.">setReadTimeout</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> msec) {
|
|
719
|
-
<a name="l00694"></a>00694 <span class="comment">// See the comment for setWriteTimeout().</span>
|
|
720
|
-
<a name="l00695"></a>00695 <span class="keyword">struct </span>timeval tv;
|
|
721
|
-
<a name="l00696"></a>00696 <span class="keywordtype">int</span> ret;
|
|
722
|
-
<a name="l00697"></a>00697
|
|
723
|
-
<a name="l00698"></a>00698 tv.tv_sec = msec / 1000;
|
|
724
|
-
<a name="l00699"></a>00699 tv.tv_usec = msec % 1000 * 1000;
|
|
725
|
-
<a name="l00700"></a>00700 ret = syscalls::setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO,
|
|
726
|
-
<a name="l00701"></a>00701 &tv, <span class="keyword">sizeof</span>(tv));
|
|
727
|
-
<a name="l00702"></a>00702 <span class="preprocessor"> #ifndef __SOLARIS__</span>
|
|
728
|
-
<a name="l00703"></a>00703 <span class="preprocessor"></span> <span class="comment">// SO_RCVTIMEO is unimplemented and returns an error on Solaris</span>
|
|
729
|
-
<a name="l00704"></a>00704 <span class="comment">// 9 and 10 SPARC. Seems to work okay without it.</span>
|
|
730
|
-
<a name="l00705"></a>00705 <span class="keywordflow">if</span> (ret == -1) {
|
|
731
|
-
<a name="l00706"></a>00706 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">"Cannot set read timeout for socket"</span>, errno);
|
|
732
|
-
<a name="l00707"></a>00707 }
|
|
733
|
-
<a name="l00708"></a>00708 <span class="preprocessor"> #endif</span>
|
|
734
|
-
<a name="l00709"></a>00709 <span class="preprocessor"></span> }
|
|
735
|
-
<a name="l00710"></a>00710 <span class="comment"></span>
|
|
736
|
-
<a name="l00711"></a>00711 <span class="comment"> /**</span>
|
|
737
|
-
<a name="l00712"></a>00712 <span class="comment"> * Set the timeout value for writing data to this channel.</span>
|
|
738
|
-
<a name="l00713"></a>00713 <span class="comment"> * If no data can be written within the timeout period, then a</span>
|
|
739
|
-
<a name="l00714"></a>00714 <span class="comment"> * SystemException will be thrown, with error code EAGAIN or</span>
|
|
740
|
-
<a name="l00715"></a>00715 <span class="comment"> * EWOULDBLOCK.</span>
|
|
741
|
-
<a name="l00716"></a>00716 <span class="comment"> *</span>
|
|
742
|
-
<a name="l00717"></a>00717 <span class="comment"> * @param msec The timeout, in milliseconds. If 0 is given,</span>
|
|
743
|
-
<a name="l00718"></a>00718 <span class="comment"> * there will be no timeout.</span>
|
|
744
|
-
<a name="l00719"></a>00719 <span class="comment"> * @throws SystemException Cannot set the timeout.</span>
|
|
745
|
-
<a name="l00720"></a>00720 <span class="comment"> */</span>
|
|
746
|
-
<a name="l00721"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a77c5d7c47f387cf43992ebeb14e3c6c7">00721</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a77c5d7c47f387cf43992ebeb14e3c6c7" title="Set the timeout value for writing data to this channel.">setWriteTimeout</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> msec) {
|
|
747
|
-
<a name="l00722"></a>00722 <span class="comment">// People say that SO_RCVTIMEO/SO_SNDTIMEO are unreliable and</span>
|
|
748
|
-
<a name="l00723"></a>00723 <span class="comment">// not well-implemented on all platforms.</span>
|
|
749
|
-
<a name="l00724"></a>00724 <span class="comment">// http://www.developerweb.net/forum/archive/index.php/t-3439.html</span>
|
|
750
|
-
<a name="l00725"></a>00725 <span class="comment">// That's why we use APR's timeout facilities as well (see Hooks.cpp).</span>
|
|
751
|
-
<a name="l00726"></a>00726 <span class="keyword">struct </span>timeval tv;
|
|
752
|
-
<a name="l00727"></a>00727 <span class="keywordtype">int</span> ret;
|
|
753
|
-
<a name="l00728"></a>00728
|
|
754
|
-
<a name="l00729"></a>00729 tv.tv_sec = msec / 1000;
|
|
755
|
-
<a name="l00730"></a>00730 tv.tv_usec = msec % 1000 * 1000;
|
|
756
|
-
<a name="l00731"></a>00731 ret = syscalls::setsockopt(fd, SOL_SOCKET, SO_SNDTIMEO,
|
|
757
|
-
<a name="l00732"></a>00732 &tv, <span class="keyword">sizeof</span>(tv));
|
|
758
|
-
<a name="l00733"></a>00733 <span class="preprocessor"> #ifndef __SOLARIS__</span>
|
|
759
|
-
<a name="l00734"></a>00734 <span class="preprocessor"></span> <span class="comment">// SO_SNDTIMEO is unimplemented and returns an error on Solaris</span>
|
|
760
|
-
<a name="l00735"></a>00735 <span class="comment">// 9 and 10 SPARC. Seems to work okay without it.</span>
|
|
761
|
-
<a name="l00736"></a>00736 <span class="keywordflow">if</span> (ret == -1) {
|
|
762
|
-
<a name="l00737"></a>00737 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">"Cannot set read timeout for socket"</span>, errno);
|
|
763
|
-
<a name="l00738"></a>00738 }
|
|
764
|
-
<a name="l00739"></a>00739 <span class="preprocessor"> #endif</span>
|
|
765
|
-
<a name="l00740"></a>00740 <span class="preprocessor"></span> }
|
|
766
|
-
<a name="l00741"></a>00741 };
|
|
767
|
-
<a name="l00742"></a>00742
|
|
768
|
-
<a name="l00743"></a>00743 } <span class="comment">// namespace Passenger</span>
|
|
769
|
-
<a name="l00744"></a>00744
|
|
770
|
-
<a name="l00745"></a>00745 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_MESSAGE_CHANNEL_H_ */</span>
|
|
771
|
-
</pre></div></div>
|
|
772
|
-
<hr size="1"/><address style="text-align: right;"><small>Generated by
|
|
773
|
-
<a href="http://www.doxygen.org/index.html">
|
|
774
|
-
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
|
|
775
|
-
</body>
|
|
776
|
-
</html>
|